{
"components": {
"schemas": {
"ACL rule": {
"discriminator": {
"mapping": {
"IPV4": "#/components/schemas/IntegrationIpAclRuleDto",
"MAC": "#/components/schemas/IntegrationMacAclRuleDto"
},
"propertyName": "type"
},
"properties": {
"action": {
"description": "ACL rule action",
"enum": [
"ALLOW",
"BLOCK"
],
"example": "ALLOW|BLOCK",
"type": "string"
},
"description": {
"description": "ACL rule description",
"type": "string"
},
"destinationFilter": {
"description": "Traffic destination filter"
},
"enabled": {
"example": true,
"type": "boolean"
},
"enforcingDeviceFilter": {
"$ref": "#/components/schemas/ACL rule device filter",
"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."
},
"id": {
"format": "uuid",
"type": "string"
},
"index": {
"description": "ACL rule index. Lower index has higher priority",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"metadata": {
"$ref": "#/components/schemas/User defined or derived entity metadata",
"description": "Only user-defined rules can be deleted or modified"
},
"name": {
"description": "ACL rule name",
"minLength": 1,
"type": "string"
},
"sourceFilter": {
"description": "Traffic source filter"
},
"type": {
"type": "string"
}
},
"required": [
"action",
"enabled",
"id",
"index",
"metadata",
"name",
"type"
],
"type": "object"
},
"ACL rule device filter": {
"discriminator": {
"mapping": {
"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"ACL rule ordering": {
"properties": {
"orderedAclRuleIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"orderedAclRuleIds"
],
"type": "object"
},
"ACL rule update": {
"discriminator": {
"mapping": {
"IPV4": "#/components/schemas/IntegrationIpAclRuleCreateUpdateDto",
"MAC": "#/components/schemas/IntegrationMacAclRuleCreateUpdateDto"
},
"propertyName": "type"
},
"properties": {
"action": {
"description": "ACL rule action",
"enum": [
"ALLOW",
"BLOCK"
],
"example": "ALLOW|BLOCK",
"type": "string"
},
"description": {
"description": "ACL rule description",
"type": "string"
},
"destinationFilter": {
"description": "Traffic destination filter"
},
"enabled": {
"example": true,
"type": "boolean"
},
"enforcingDeviceFilter": {
"$ref": "#/components/schemas/ACL rule device filter",
"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."
},
"index": {
"deprecated": true,
"description": "ACL rule index. This property is deprecated and has no effect. Use the dedicated ACL rule reordering endpoint.",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"name": {
"description": "ACL rule name",
"minLength": 1,
"type": "string"
},
"sourceFilter": {
"description": "Traffic source filter"
},
"type": {
"type": "string"
}
},
"required": [
"action",
"enabled",
"name",
"type"
],
"type": "object"
},
"ACL ruleObject": {
"discriminator": {
"mapping": {
"IPV4": "#/components/schemas/IntegrationIpAclRuleDto",
"MAC": "#/components/schemas/IntegrationMacAclRuleDto"
},
"propertyName": "type"
},
"properties": {
"action": {
"description": "ACL rule action",
"enum": [
"ALLOW",
"BLOCK"
],
"example": "ALLOW|BLOCK",
"type": "string"
},
"description": {
"description": "ACL rule description",
"type": "string"
},
"destinationFilter": {
"description": "Traffic destination filter"
},
"enabled": {
"example": true,
"type": "boolean"
},
"enforcingDeviceFilter": {
"$ref": "#/components/schemas/ACL rule device filter",
"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."
},
"id": {
"format": "uuid",
"type": "string"
},
"index": {
"description": "ACL rule index. Lower index has higher priority",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"metadata": {
"$ref": "#/components/schemas/User defined or derived entity metadata",
"description": "Only user-defined rules can be deleted or modified"
},
"name": {
"description": "ACL rule name",
"minLength": 1,
"type": "string"
},
"sourceFilter": {
"description": "Traffic source filter"
},
"type": {
"type": "string"
}
},
"required": [
"action",
"enabled",
"id",
"index",
"metadata",
"name",
"type"
],
"type": "object"
},
"Access point feature overview": {},
"Address IPv4 matching": {
"allOf": [
{
"$ref": "#/components/schemas/IPv4 matching"
},
{
"properties": {
"value": {
"description": "IPv4 address",
"example": "192.168.1.5",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"value"
]
},
"Address IPv6 matching": {
"allOf": [
{
"$ref": "#/components/schemas/IPv6 matching"
},
{
"properties": {
"value": {
"description": "IPv6 address",
"example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"value"
]
},
"Address range IPv4 matching": {
"allOf": [
{
"$ref": "#/components/schemas/IPv4 matching"
},
{
"properties": {
"start": {
"description": "IPv4 start address",
"example": "192.168.1.10",
"type": "string"
},
"stop": {
"description": "IPv4 stop address",
"example": "192.168.1.20",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"start",
"stop"
]
},
"Adopted device details": {
"properties": {
"adoptedAt": {
"format": "date-time",
"type": "string"
},
"configurationId": {
"example": "7596498d2f367dc2",
"type": "string"
},
"features": {
"$ref": "#/components/schemas/Device features"
},
"firmwareUpdatable": {
"type": "boolean"
},
"firmwareVersion": {
"example": "6.6.55",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"interfaces": {
"$ref": "#/components/schemas/Device physical interfaces"
},
"ipAddress": {
"example": "192.168.1.55",
"type": "string"
},
"macAddress": {
"example": "94:2a:6f:26:c6:ca",
"type": "string"
},
"model": {
"example": "UHDIW",
"type": "string"
},
"name": {
"example": "IW HD",
"type": "string"
},
"provisionedAt": {
"format": "date-time",
"type": "string"
},
"state": {
"enum": [
"ONLINE",
"OFFLINE",
"PENDING_ADOPTION",
"UPDATING",
"GETTING_READY",
"ADOPTING",
"DELETING",
"CONNECTION_INTERRUPTED",
"ISOLATED",
"U5G_INCORRECT_TOPOLOGY"
],
"type": "string"
},
"supported": {
"type": "boolean"
},
"uplink": {
"$ref": "#/components/schemas/Device uplink interface overview"
}
},
"required": [
"configurationId",
"features",
"firmwareUpdatable",
"id",
"interfaces",
"ipAddress",
"macAddress",
"model",
"name",
"state",
"supported"
],
"type": "object"
},
"Adopted device overview": {
"properties": {
"features": {
"items": {
"enum": [
"switching",
"accessPoint",
"gateway"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"firmwareUpdatable": {
"type": "boolean"
},
"firmwareVersion": {
"example": "6.6.55",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"interfaces": {
"items": {
"enum": [
"ports",
"radios"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"ipAddress": {
"example": "192.168.1.55",
"type": "string"
},
"macAddress": {
"example": "94:2a:6f:26:c6:ca",
"type": "string"
},
"model": {
"example": "UHDIW",
"type": "string"
},
"name": {
"example": "IW HD",
"type": "string"
},
"state": {
"enum": [
"ONLINE",
"OFFLINE",
"PENDING_ADOPTION",
"UPDATING",
"GETTING_READY",
"ADOPTING",
"DELETING",
"CONNECTION_INTERRUPTED",
"ISOLATED",
"U5G_INCORRECT_TOPOLOGY"
],
"type": "string"
},
"supported": {
"type": "boolean"
}
},
"required": [
"features",
"firmwareUpdatable",
"id",
"interfaces",
"ipAddress",
"macAddress",
"model",
"name",
"state",
"supported"
],
"type": "object"
},
"Adopted device overview page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Adopted device overview"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"Application info": {
"properties": {
"applicationVersion": {
"example": "9.1.0",
"type": "string"
}
},
"required": [
"applicationVersion"
],
"type": "object"
},
"Blackout schedule configuration per day": {
"discriminator": {
"mapping": {
"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto",
"TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"
},
"propertyName": "type"
},
"properties": {
"day": {
"enum": [
"SUN",
"MON",
"TUE",
"WED",
"THU",
"FRI",
"SAT"
],
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"day",
"type"
],
"type": "object"
},
"BooleanType": {
"allOf": [
{
"$ref": "#/components/schemas/ScalarType"
}
]
},
"Broadcasting device filter": {
"discriminator": {
"mapping": {
"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto",
"DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Client access overview": {
"example": {
"type": "DEFAULT"
}
},
"Client action request": {
"discriminator": {
"mapping": {
"AUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access authorization request",
"UNAUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access unauthorization request"
},
"propertyName": "action"
},
"properties": {
"action": {
"type": "string"
}
},
"required": [
"action"
]
},
"Client action response": {
"discriminator": {
"mapping": {
"AUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access authorization response",
"UNAUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access unauthorization response"
},
"propertyName": "action"
},
"properties": {
"action": {
"type": "string"
}
},
"required": [
"action"
]
},
"Client details": {
"discriminator": {
"mapping": {
"TELEPORT": "#/components/schemas/Teleport client (connection) details",
"VPN": "#/components/schemas/VPN client (connection) details",
"WIRED": "#/components/schemas/Wired client details",
"WIRELESS": "#/components/schemas/Wireless client details"
},
"propertyName": "type"
},
"properties": {
"access": {},
"connectedAt": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"ipAddress": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"access",
"id",
"name",
"type"
],
"type": "object"
},
"Client overview": {
"discriminator": {
"mapping": {
"TELEPORT": "#/components/schemas/Teleport client (connection) overview",
"VPN": "#/components/schemas/VPN client (connection) overview",
"WIRED": "#/components/schemas/Wired client overview",
"WIRELESS": "#/components/schemas/Wireless client overview"
},
"propertyName": "type"
},
"properties": {
"access": {
"$ref": "#/components/schemas/Client access overview"
},
"connectedAt": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"ipAddress": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"access",
"id",
"name",
"type"
],
"type": "object"
},
"Client overview page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Client overview"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"CompoundFilterExpression": {
"allOf": [
{
"$ref": "#/components/schemas/FilterExpression"
},
{
"properties": {
"expressions": {
"items": {},
"type": "array"
},
"operator": {
"enum": [
"AND",
"OR",
"NOT"
],
"type": "string"
}
},
"type": "object"
}
]
},
"Country Definition": {
"properties": {
"code": {
"description": "The country code in ISO 3166-1 alpha-2 format.",
"example": "CK|FK|KY",
"type": "string"
},
"name": {
"description": "The country name.",
"example": "Cook Islands|Falkland Islands, Malvinas|Cayman Islands",
"type": "string"
}
},
"required": [
"code",
"name"
],
"type": "object"
},
"Country definition page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Country Definition"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"Create or update DNS policy": {
"discriminator": {
"mapping": {
"AAAA_RECORD": "#/components/schemas/IntegrationDnsAaaaRecordCreateUpdateDto",
"A_RECORD": "#/components/schemas/IntegrationDnsARecordCreateUpdateDto",
"CNAME_RECORD": "#/components/schemas/IntegrationDnsCnameRecordCreateUpdateDto",
"FORWARD_DOMAIN": "#/components/schemas/IntegrationDnsForwardDomainPolicyCreateUpdateDto",
"MX_RECORD": "#/components/schemas/IntegrationDnsMxRecordCreateUpdateDto",
"SRV_RECORD": "#/components/schemas/IntegrationDnsSrvRecordCreateUpdateDto",
"TXT_RECORD": "#/components/schemas/IntegrationDnsTxtRecordCreateUpdateDto"
},
"propertyName": "type"
},
"properties": {
"enabled": {
"type": "boolean"
},
"type": {
"type": "string"
}
},
"required": [
"enabled",
"type"
],
"type": "object"
},
"Create or update Network": {
"discriminator": {
"mapping": {
"GATEWAY": "#/components/schemas/IntegrationGatewayManagedNetworkCreateUpdateDto",
"SWITCH": "#/components/schemas/IntegrationSwitchManagedNetworkCreateUpdateDto",
"UNMANAGED": "#/components/schemas/IntegrationUnmanagedNetworkCreateUpdateDto"
},
"propertyName": "management"
},
"properties": {
"dhcpGuarding": {
"$ref": "#/components/schemas/Network DHCP Guarding",
"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled"
},
"enabled": {
"type": "boolean"
},
"management": {
"type": "string"
},
"name": {
"example": "Default Network",
"type": "string"
},
"vlanId": {
"description": "VLAN ID. Must be 1 for the default network and >= 2 for additional networks.",
"format": "int32",
"maximum": 4009,
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled",
"management",
"name",
"vlanId"
],
"type": "object"
},
"Create or update firewall policy": {
"properties": {
"action": {
"$ref": "#/components/schemas/Firewall policy action"
},
"connectionStateFilter": {
"description": "Match on firewall connection state. If null, matches all connection states.",
"items": {
"enum": [
"NEW",
"INVALID",
"ESTABLISHED",
"RELATED"
],
"type": "string"
},
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"description": {
"example": "A description for my firewall policy",
"type": "string"
},
"destination": {
"$ref": "#/components/schemas/Firewall policy destination"
},
"enabled": {
"type": "boolean"
},
"ipProtocolScope": {
"$ref": "#/components/schemas/Firewall policy IP protocol scope"
},
"ipsecFilter": {
"description": "Match on traffic encrypted, or not encrypted by IPsec. If null, matches all traffic.",
"enum": [
"MATCH_ENCRYPTED",
"MATCH_NOT_ENCRYPTED"
],
"type": "string"
},
"loggingEnabled": {
"description": "Generate syslog entries when traffic is matched. Such entries are sent to a remote syslog server.",
"type": "boolean"
},
"name": {
"example": "My firewall policy",
"minLength": 1,
"type": "string"
},
"schedule": {
"$ref": "#/components/schemas/Firewall schedule"
},
"source": {
"$ref": "#/components/schemas/Firewall policy source"
}
},
"required": [
"action",
"destination",
"enabled",
"ipProtocolScope",
"loggingEnabled",
"name",
"source"
],
"type": "object"
},
"Create or update firewall zone": {
"properties": {
"name": {
"description": "Name of a firewall zone",
"example": "Hotspot|My custom zone",
"type": "string"
},
"networkIds": {
"description": "List of Network IDs",
"items": {
"example": "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b",
"format": "uuid",
"type": "string"
},
"minItems": 0,
"type": "array"
}
},
"required": [
"name",
"networkIds"
],
"type": "object"
},
"Create or update traffic matching list": {
"discriminator": {
"mapping": {
"IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListCreateUpdateDto",
"IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListCreateUpdateDto",
"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListCreateUpdateDto"
},
"propertyName": "type"
},
"properties": {
"name": {
"example": "Allowed port list|Protected IP list",
"minLength": 1,
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"DHCP Configuration for IPv6 Network": {
"properties": {
"ipAddressSuffixRange": {
"$ref": "#/components/schemas/IntegrationIpv6AddressSuffixRangeSelectorDto"
},
"leaseTimeSeconds": {
"description": "The lease time in seconds for IP addresses in this range.",
"format": "int32",
"maximum": 31536000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"ipAddressSuffixRange",
"leaseTimeSeconds"
],
"type": "object"
},
"DNS assistance configuration": {
"discriminator": {
"mapping": {
"AUTO": "#/components/schemas/IntegrationWifiDnsAssistanceAutoConfigurationDto",
"MANUAL": "#/components/schemas/IntegrationWifiDnsAssistanceManualConfigurationDto"
},
"propertyName": "mode"
},
"properties": {
"mode": {
"type": "string"
}
},
"required": [
"mode"
]
},
"DNS policy": {
"discriminator": {
"mapping": {
"AAAA_RECORD": "#/components/schemas/IntegrationDnsAaaaRecordDto",
"A_RECORD": "#/components/schemas/IntegrationDnsARecordDto",
"CNAME_RECORD": "#/components/schemas/IntegrationDnsCnameRecordDto",
"FORWARD_DOMAIN": "#/components/schemas/IntegrationDnsForwardDomainPolicyDto",
"MX_RECORD": "#/components/schemas/IntegrationDnsMxRecordDto",
"SRV_RECORD": "#/components/schemas/IntegrationDnsSrvRecordDto",
"TXT_RECORD": "#/components/schemas/IntegrationDnsTxtRecordDto"
},
"propertyName": "type"
},
"properties": {
"domain": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/User defined entity metadata"
},
"type": {
"type": "string"
}
},
"required": [
"enabled",
"id",
"metadata",
"type"
],
"type": "object"
},
"DPI application": {
"properties": {
"id": {
"example": "786435|720973",
"format": "int32",
"type": "integer"
},
"name": {
"example": "Adobe Express|Zoom",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"DPI application page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/DPI application"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"DPI category": {
"properties": {
"id": {
"example": "3|5",
"format": "int32",
"type": "integer"
},
"name": {
"example": "Network protocols|Business tools",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"DPI category page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/DPI category"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"DecimalType": {
"allOf": [
{
"$ref": "#/components/schemas/ScalarType"
}
]
},
"Default client access details": {
"allOf": [
{
"$ref": "#/components/schemas/Local client access details"
},
{
"$ref": "#/components/schemas/VPN client access details"
},
{
"$ref": "#/components/schemas/Teleport client access details"
}
]
},
"Default client access overview": {
"allOf": [
{
"$ref": "#/components/schemas/Local client access overview"
},
{
"$ref": "#/components/schemas/VPN client access overview"
},
{
"$ref": "#/components/schemas/Teleport client access overview"
}
]
},
"Derived entity metadata": {
"allOf": [
{
"$ref": "#/components/schemas/Entity metadata"
}
]
},
"Device action request": {
"discriminator": {
"mapping": {
"RESTART": "#/components/schemas/Device restart request"
},
"propertyName": "action"
},
"properties": {
"action": {
"type": "string"
}
},
"required": [
"action"
]
},
"Device features": {
"properties": {
"accessPoint": {
"$ref": "#/components/schemas/Access point feature overview",
"example": {}
},
"switching": {
"$ref": "#/components/schemas/Switching feature overview"
}
},
"type": "object"
},
"Device pending adoption": {
"properties": {
"adoptionTargetSiteIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"features": {
"items": {
"enum": [
"switching",
"accessPoint",
"gateway"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"firmwareUpdatable": {
"type": "boolean"
},
"firmwareVersion": {
"example": "6.6.55",
"type": "string"
},
"ipAddress": {
"example": "192.168.1.55",
"type": "string"
},
"macAddress": {
"example": "94:2a:6f:26:c6:ca",
"type": "string"
},
"model": {
"example": "UHDIW",
"type": "string"
},
"state": {
"enum": [
"ONLINE",
"OFFLINE",
"PENDING_ADOPTION",
"UPDATING",
"GETTING_READY",
"ADOPTING",
"DELETING",
"CONNECTION_INTERRUPTED",
"ISOLATED",
"U5G_INCORRECT_TOPOLOGY"
],
"type": "string"
},
"supported": {
"type": "boolean"
}
},
"required": [
"adoptionTargetSiteIds",
"features",
"firmwareUpdatable",
"ipAddress",
"macAddress",
"model",
"state",
"supported"
],
"type": "object"
},
"Device pending adoption page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Device pending adoption"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"Device physical interfaces": {
"properties": {
"ports": {
"items": {
"$ref": "#/components/schemas/Port overview"
},
"type": "array"
},
"radios": {
"items": {
"$ref": "#/components/schemas/Wireless radio overview"
},
"type": "array"
}
},
"type": "object"
},
"Device restart request": {
"allOf": [
{
"$ref": "#/components/schemas/Device action request"
}
]
},
"Device tag": {
"properties": {
"deviceIds": {
"items": {
"format": "uuid",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"id": {
"format": "uuid",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/User or orchestrated entity metadata"
},
"name": {
"minLength": 1,
"type": "string"
}
},
"required": [
"deviceIds",
"id",
"metadata",
"name"
],
"type": "object"
},
"Device uplink interface overview": {
"description": "Uplink interface is device's connection to the parent device in the network topology",
"properties": {
"deviceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"deviceId"
],
"type": "object"
},
"Entity metadata": {
"discriminator": {
"mapping": {
"DERIVED": "#/components/schemas/Derived entity metadata",
"ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata",
"SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata",
"USER_DEFINED": "#/components/schemas/User defined entity metadata"
},
"propertyName": "origin"
},
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
]
},
"Error Message": {
"properties": {
"code": {
"example": "api.authentication.missing-credentials",
"type": "string"
},
"message": {
"example": "Missing credentials",
"type": "string"
},
"requestId": {
"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",
"format": "uuid",
"type": "string"
},
"requestPath": {
"example": "/integration/v1/sites/123",
"type": "string"
},
"statusCode": {
"example": 400,
"format": "int32",
"type": "integer"
},
"statusName": {
"example": "UNAUTHORIZED",
"type": "string"
},
"timestamp": {
"example": "2024-11-27T08:13:46.966Z",
"format": "date-time",
"type": "string"
}
},
"x-tags": "Error Handling"
},
"FilterExpression": {},
"FilterPath": {
"properties": {
"depth": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"names": {
"items": {
"type": "string"
},
"type": "array"
},
"parent": {}
},
"type": "object"
},
"FilterableEntity": {
"properties": {
"name": {
"type": "string"
},
"nestedEntities": {
"additionalProperties": {},
"type": "object"
},
"path": {
"$ref": "#/components/schemas/FilterPath"
},
"properties": {
"additionalProperties": {
"$ref": "#/components/schemas/FilterableProperty"
},
"type": "object"
}
},
"type": "object"
},
"FilterableProperty": {
"properties": {
"name": {
"type": "string"
},
"path": {
"$ref": "#/components/schemas/FilterPath"
},
"type": {
"$ref": "#/components/schemas/FilterablePropertyType"
}
},
"type": "object"
},
"FilterablePropertyType": {
"properties": {
"allowedFunctions": {
"items": {
"enum": [
"IS_NULL",
"IS_NOT_NULL",
"EQ",
"NE",
"GT",
"GE",
"LT",
"LE",
"LIKE",
"IN",
"NOT_IN",
"IS_EMPTY",
"CONTAINS",
"CONTAINS_ANY",
"CONTAINS_ALL",
"CONTAINS_EXACTLY"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"supportedFunctions": {
"items": {
"enum": [
"IS_NULL",
"IS_NOT_NULL",
"EQ",
"NE",
"GT",
"GE",
"LT",
"LE",
"LIKE",
"IN",
"NOT_IN",
"IS_EMPTY",
"CONTAINS",
"CONTAINS_ANY",
"CONTAINS_ALL",
"CONTAINS_EXACTLY"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"valueType": {
"enum": [
"STRING",
"INTEGER",
"DECIMAL",
"UUID",
"TIMESTAMP",
"BOOLEAN"
],
"type": "string"
}
},
"type": "object"
},
"Firewall policy": {
"properties": {
"action": {
"$ref": "#/components/schemas/Firewall policy action"
},
"connectionStateFilter": {
"description": "Match on firewall connection state. If null, matches all connection states.",
"items": {
"enum": [
"NEW",
"INVALID",
"ESTABLISHED",
"RELATED"
],
"type": "string"
},
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"description": {
"example": "A description for my firewall policy",
"type": "string"
},
"destination": {
"$ref": "#/components/schemas/Firewall policy destination"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"index": {
"format": "int32",
"type": "integer"
},
"ipProtocolScope": {
"$ref": "#/components/schemas/Firewall policy IP protocol scope"
},
"ipsecFilter": {
"description": "Match on traffic encrypted, or not encrypted by IPsec. If null, matches all traffic.",
"enum": [
"MATCH_ENCRYPTED",
"MATCH_NOT_ENCRYPTED"
],
"type": "string"
},
"loggingEnabled": {
"description": "Generate syslog entries when traffic is matched. Such entries are sent to a remote syslog server.",
"type": "boolean"
},
"metadata": {
"$ref": "#/components/schemas/User or system defined or derived entity metadata"
},
"name": {
"example": "My firewall policy",
"type": "string"
},
"schedule": {
"$ref": "#/components/schemas/Firewall schedule"
},
"source": {
"$ref": "#/components/schemas/Firewall policy source"
}
},
"required": [
"action",
"destination",
"enabled",
"id",
"index",
"ipProtocolScope",
"loggingEnabled",
"metadata",
"name",
"source"
],
"type": "object"
},
"Firewall policy IP address filter": {
"description": "Match traffic originating from, or destined to selected IP addresses.",
"discriminator": {
"mapping": {
"IP_ADDRESSES": "#/components/schemas/IntegrationFirewallPolicySpecificIpAddressFilterDto",
"TRAFFIC_MATCHING_LIST": "#/components/schemas/IntegrationFirewallPolicyIpAddressTrafficMatchingListFilterDto"
},
"propertyName": "type"
},
"properties": {
"matchOpposite": {
"description": "Match on all IP addresses except the specified ones.",
"type": "boolean"
},
"type": {
"type": "string"
}
},
"required": [
"matchOpposite",
"type"
],
"type": "object"
},
"Firewall policy IP protocol scope": {
"description": "Defines rules for matching by IP version and protocol.",
"discriminator": {
"mapping": {
"IPV4": "#/components/schemas/IntegrationFirewallPolicyIpv4ProtocolScopeDto",
"IPV4_AND_IPV6": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6ProtocolScopeDto",
"IPV6": "#/components/schemas/IntegrationFirewallPolicyIpv6ProtocolScopeDto"
},
"propertyName": "ipVersion"
},
"properties": {
"ipVersion": {
"type": "string"
}
},
"required": [
"ipVersion"
]
},
"Firewall policy IPv4 and IPv6 named protocol": {
"description": "Defines rules for matching by protocol name.",
"discriminator": {
"mapping": {
"AH": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"DCCP": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"EIGRP": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"ESP": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"GRE": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"IPCOMP": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"ISIS": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"L2TP": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"MANET": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"MOBILITY_HEADER": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"MPLS_IN_IP": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"OSPF": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"PIM": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"RSVP": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"SCTP": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"SHIM6": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"TCP": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"UDP": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto",
"VRRP": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto"
},
"propertyName": "name"
},
"properties": {
"name": {
"enum": [
"ah",
"ax.25",
"dccp",
"ddp",
"egp",
"eigrp",
"encap",
"esp",
"etherip",
"fc",
"ggp",
"gre",
"hip",
"hmp",
"icmp",
"icmpv6",
"idpr-cmtp",
"idrp",
"igmp",
"igp",
"ip",
"ipcomp",
"ipencap",
"ipip",
"ipv6",
"ipv6-frag",
"ipv6-nonxt",
"ipv6-opts",
"ipv6-route",
"isis",
"iso-tp4",
"l2tp",
"manet",
"mobility-header",
"mpls-in-ip",
"ospf",
"pim",
"pup",
"rdp",
"rohc",
"rspf",
"rsvp",
"sctp",
"shim6",
"skip",
"st",
"tcp",
"tcp_udp",
"udp",
"udplite",
"vmtp",
"vrrp",
"wesp",
"xns-idp",
"xtp"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Firewall policy IPv4 and IPv6 protocol": {
"description": "Defines protocol matching. If null, matches all protocols.",
"discriminator": {
"mapping": {
"NAMED_PROTOCOL": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolFilterDto",
"PRESET": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6ProtocolPresetFilterDto",
"PROTOCOL_NUMBER": "#/components/schemas/Firewall policy IPv4 and IPv6 protocol number"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Firewall policy IPv4 and IPv6 protocol number": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 protocol"
},
{
"properties": {
"matchOpposite": {
"description": "Match on all protocols except the specified protocol.",
"type": "boolean"
},
"protocolNumber": {
"description": "Protocol number as defined by IANA.",
"format": "int32",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
],
"description": "Defines rules for matching by protocol number.",
"required": [
"matchOpposite",
"protocolNumber"
]
},
"Firewall policy IPv4 and IPv6 protocol preset": {
"description": "Defines rules for matching by protocol preset.",
"discriminator": {
"mapping": {
"TCP_UDP": "#/components/schemas/IntegrationFirewallPolicyIpv4AndIpv6ProtocolPresetTcpUdpDto"
},
"propertyName": "name"
},
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
},
"Firewall policy IPv4 named protocol": {
"description": "Defines rules for matching by protocol name.",
"discriminator": {
"mapping": {
"AH": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"AX_25": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"DCCP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"DDP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"EGP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"EIGRP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"ENCAP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"ESP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"ETHERIP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"FC": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"GGP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"GRE": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"HIP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"HMP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"ICMP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolIcmpDto",
"IDPR_CMTP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"IDRP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"IGMP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"IGP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"IP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"IPCOMP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"IPENCAP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"IPIP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"ISIS": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"ISO_TP4": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"L2TP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"MANET": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"MOBILITY_HEADER": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"MPLS_IN_IP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"OSPF": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"PIM": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"PUP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"RDP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"ROHC": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"RSPF": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"RSVP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"SCTP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"SHIM6": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"SKIP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"ST": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"TCP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"UDP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"UDPLITE": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"VMTP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"VRRP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"WESP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"XNS_IDP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto",
"XTP": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto"
},
"propertyName": "name"
},
"properties": {
"name": {
"enum": [
"ah",
"ax.25",
"dccp",
"ddp",
"egp",
"eigrp",
"encap",
"esp",
"etherip",
"fc",
"ggp",
"gre",
"hip",
"hmp",
"icmp",
"icmpv6",
"idpr-cmtp",
"idrp",
"igmp",
"igp",
"ip",
"ipcomp",
"ipencap",
"ipip",
"ipv6",
"ipv6-frag",
"ipv6-nonxt",
"ipv6-opts",
"ipv6-route",
"isis",
"iso-tp4",
"l2tp",
"manet",
"mobility-header",
"mpls-in-ip",
"ospf",
"pim",
"pup",
"rdp",
"rohc",
"rspf",
"rsvp",
"sctp",
"shim6",
"skip",
"st",
"tcp",
"tcp_udp",
"udp",
"udplite",
"vmtp",
"vrrp",
"wesp",
"xns-idp",
"xtp"
],
"type": "string"
}
},
"type": "object"
},
"Firewall policy IPv4 protocol": {
"description": "Defines protocol matching. If null, matches all protocols.",
"discriminator": {
"mapping": {
"NAMED_PROTOCOL": "#/components/schemas/IntegrationFirewallPolicyIpv4NamedProtocolFilterDto",
"PRESET": "#/components/schemas/IntegrationFirewallPolicyIpv4ProtocolPresetFilterDto",
"PROTOCOL_NUMBER": "#/components/schemas/Firewall policy IPv4 protocol number"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Firewall policy IPv4 protocol number": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv6 protocol"
},
{
"properties": {
"matchOpposite": {
"description": "Match on all protocols except the specified protocol.",
"type": "boolean"
},
"protocolNumber": {
"description": "Protocol number as defined by IANA.",
"format": "int32",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
],
"description": "Defines rules for matching by protocol number.",
"required": [
"matchOpposite",
"protocolNumber"
]
},
"Firewall policy IPv4 protocol preset": {
"description": "Defines rules for matching by protocol preset.",
"discriminator": {
"mapping": {
"TCP_UDP": "#/components/schemas/IntegrationFirewallPolicyIpv4ProtocolPresetTcpUdpDto"
},
"propertyName": "name"
},
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
},
"Firewall policy IPv6 interface identifier filter": {
"properties": {
"ipv6Iid": {
"description": "IPv6 Interface Identifier.",
"example": "2001:db8::1/::ffff:ffff:ffff:ffff",
"minLength": 1,
"type": "string"
},
"matchOpposite": {
"description": "Match on all IPv6 IIDs except the specified one.",
"type": "boolean"
}
},
"required": [
"ipv6Iid",
"matchOpposite"
],
"type": "object"
},
"Firewall policy IPv6 named protocol": {
"description": "Defines rules for matching by protocol name.",
"discriminator": {
"mapping": {
"AH": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"DCCP": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"EIGRP": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"ESP": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"GRE": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"ICMPV6": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolIcmpv6Dto",
"IPCOMP": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"IPV6": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"IPV6_FRAG": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"IPV6_NONXT": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"IPV6_OPTS": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"IPV6_ROUTE": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"ISIS": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"L2TP": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"MANET": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"MOBILITY_HEADER": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"MPLS_IN_IP": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"OSPF": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"PIM": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"RSVP": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"SCTP": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"SHIM6": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"TCP": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"UDP": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto",
"VRRP": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto"
},
"propertyName": "name"
},
"properties": {
"name": {
"enum": [
"ah",
"ax.25",
"dccp",
"ddp",
"egp",
"eigrp",
"encap",
"esp",
"etherip",
"fc",
"ggp",
"gre",
"hip",
"hmp",
"icmp",
"icmpv6",
"idpr-cmtp",
"idrp",
"igmp",
"igp",
"ip",
"ipcomp",
"ipencap",
"ipip",
"ipv6",
"ipv6-frag",
"ipv6-nonxt",
"ipv6-opts",
"ipv6-route",
"isis",
"iso-tp4",
"l2tp",
"manet",
"mobility-header",
"mpls-in-ip",
"ospf",
"pim",
"pup",
"rdp",
"rohc",
"rspf",
"rsvp",
"sctp",
"shim6",
"skip",
"st",
"tcp",
"tcp_udp",
"udp",
"udplite",
"vmtp",
"vrrp",
"wesp",
"xns-idp",
"xtp"
],
"type": "string"
}
},
"type": "object"
},
"Firewall policy IPv6 protocol": {
"description": "Defines protocol matching. If null, matches all protocols.",
"discriminator": {
"mapping": {
"NAMED_PROTOCOL": "#/components/schemas/IntegrationFirewallPolicyIpv6NamedProtocolFilterDto",
"PRESET": "#/components/schemas/IntegrationFirewallPolicyIpv6ProtocolPresetFilterDto",
"PROTOCOL_NUMBER": "#/components/schemas/Firewall policy IPv4 protocol number"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Firewall policy IPv6 protocol preset": {
"description": "Defines rules for matching by protocol preset.",
"discriminator": {
"mapping": {
"TCP_UDP": "#/components/schemas/IntegrationFirewallPolicyIpv6ProtocolPresetTcpUdpDto"
},
"propertyName": "name"
},
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
},
"Firewall policy MAC address filter": {
"properties": {
"macAddresses": {
"description": "Array of MAC addresses to match.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"macAddresses"
],
"type": "object"
},
"Firewall policy VPN server filter": {
"properties": {
"matchOpposite": {
"type": "boolean"
},
"vpnServerIds": {
"items": {
"format": "uuid",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"matchOpposite",
"vpnServerIds"
],
"type": "object"
},
"Firewall policy action": {
"description": "Defines action for matched traffic.",
"discriminator": {
"mapping": {
"ALLOW": "#/components/schemas/IntegrationFirewallPolicyActionAllowDto",
"BLOCK": "#/components/schemas/IntegrationFirewallPolicyActionBlockDto",
"REJECT": "#/components/schemas/IntegrationFirewallPolicyActionRejectDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Firewall policy application category filter": {
"properties": {
"applicationCategoryIds": {
"description": "Array of DPI Category IDs to match.",
"items": {
"format": "int32",
"type": "integer"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"applicationCategoryIds"
],
"type": "object"
},
"Firewall policy application filter": {
"properties": {
"applicationIds": {
"description": "Array of DPI Application IDs to match.",
"items": {
"format": "int32",
"type": "integer"
},
"maxItems": 100,
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"applicationIds"
],
"type": "object"
},
"Firewall policy destination": {
"properties": {
"trafficFilter": {
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
"zoneId": {
"description": "ID of the firewall zone to which the matched traffic is destined.",
"format": "uuid",
"type": "string"
}
},
"required": [
"zoneId"
],
"type": "object"
},
"Firewall policy destination traffic filter": {
"discriminator": {
"mapping": {
"APPLICATION": "#/components/schemas/IntegrationFirewallPolicyDestinationApplicationFilterDto",
"APPLICATION_CATEGORY": "#/components/schemas/IntegrationFirewallPolicyDestinationApplicationCategoryFilterDto",
"DOMAIN": "#/components/schemas/IntegrationFirewallPolicyDestinationDomainFilterDto",
"IPV6_IID": "#/components/schemas/IntegrationFirewallPolicyDestinationIpv6IidFilterDto",
"IP_ADDRESS": "#/components/schemas/IntegrationFirewallPolicyDestinationIpAddressFilterDto",
"NETWORK": "#/components/schemas/IntegrationFirewallPolicyDestinationNetworkFilterDto",
"PORT": "#/components/schemas/IntegrationFirewallPolicyDestinationPortFilterDto",
"REGION": "#/components/schemas/IntegrationFirewallPolicyDestinationRegionFilterDto",
"SITE_TO_SITE_VPN_TUNNEL": "#/components/schemas/IntegrationFirewallPolicyDestinationSiteToSiteVpnTunnelFilterDto",
"VPN_SERVER": "#/components/schemas/IntegrationFirewallPolicyDestinationVpnServerFilterDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Firewall policy domain filter": {
"discriminator": {
"mapping": {
"DOMAINS": "#/components/schemas/IntegrationFirewallPolicySpecificDomainFilterDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Firewall policy network filter": {
"properties": {
"matchOpposite": {
"description": "Match on all Networks except the selected.",
"type": "boolean"
},
"networkIds": {
"description": "Array of Network IDs to match.",
"items": {
"format": "uuid",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"matchOpposite",
"networkIds"
],
"type": "object"
},
"Firewall policy page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Firewall policy"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"Firewall policy port filter": {
"description": "Defines rules for matching traffic by port.",
"discriminator": {
"mapping": {
"PORTS": "#/components/schemas/IntegrationFirewallPolicyPortValueFilterDto",
"TRAFFIC_MATCHING_LIST": "#/components/schemas/IntegrationFirewallPolicyPortReferenceFilterDto"
},
"propertyName": "type"
},
"properties": {
"matchOpposite": {
"description": "Match on all ports except the specified ones.",
"type": "boolean"
},
"type": {
"type": "string"
}
},
"required": [
"matchOpposite",
"type"
],
"type": "object"
},
"Firewall policy region filter": {
"properties": {
"regions": {
"description": "Match traffic originating from selected regions. Regions are identified by their ISO 3166-1 alpha-2 country codes.",
"items": {
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"XK",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"regions"
],
"type": "object"
},
"Firewall policy site-to-site VPN tunnel filter": {
"properties": {
"siteToSiteVpnTunnelId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"siteToSiteVpnTunnelId"
],
"type": "object"
},
"Firewall policy source": {
"properties": {
"trafficFilter": {
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
"zoneId": {
"description": "ID of the firewall zone from which the matched traffic originates.",
"format": "uuid",
"type": "string"
}
},
"required": [
"zoneId"
],
"type": "object"
},
"Firewall policy source traffic filter": {
"discriminator": {
"mapping": {
"IPV6_IID": "#/components/schemas/IntegrationFirewallPolicySourceIpv6IidFilterDto",
"IP_ADDRESS": "#/components/schemas/IntegrationFirewallPolicySourceIpAddressFilterDto",
"MAC_ADDRESS": "#/components/schemas/IntegrationFirewallPolicySourceMacAddressFilterDto",
"NETWORK": "#/components/schemas/IntegrationFirewallPolicySourceNetworkFilterDto",
"PORT": "#/components/schemas/IntegrationFirewallPolicySourcePortFilterDto",
"REGION": "#/components/schemas/IntegrationFirewallPolicySourceRegionFilterDto",
"SITE_TO_SITE_VPN_TUNNEL": "#/components/schemas/IntegrationFirewallPolicySourceSiteToSiteVpnTunnelFilterDto",
"VPN_SERVER": "#/components/schemas/IntegrationFirewallPolicySourceVpnServerFilterDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Firewall schedule": {
"description": "Defines date and time when the entity is active. If null, the entity is always active.",
"discriminator": {
"mapping": {
"CUSTOM": "#/components/schemas/IntegrationFirewallScheduleCustomDto",
"EVERY_DAY": "#/components/schemas/IntegrationFirewallScheduleEveryDayDto",
"EVERY_WEEK": "#/components/schemas/IntegrationFirewallScheduleEveryWeekDto",
"ONE_TIME_ONLY": "#/components/schemas/IntegrationFirewallScheduleOneTimeOnlyDto"
},
"propertyName": "mode"
},
"properties": {
"mode": {
"type": "string"
}
},
"required": [
"mode"
]
},
"Firewall schedule time": {
"description": "Defines the time range when the entity is active. If null, the entity is active all day.",
"properties": {
"startTime": {
"description": "Time in HH:MM format. Uses 24-hour clock system. ISO 8601 compliant.",
"example": "21:37",
"type": "string"
},
"stopTime": {
"description": "Time in HH:MM format. Uses 24-hour clock system. ISO 8601 compliant.",
"example": "21:37",
"type": "string"
}
},
"required": [
"startTime",
"stopTime"
],
"type": "object"
},
"Firewall zone": {
"properties": {
"id": {
"example": "ffcdb32c-6278-4364-8947-df4f77118df8",
"format": "uuid",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/User or system defined entity metadata",
"description": "System-defined configurable zones support configuring only attached networks"
},
"name": {
"description": "Name of a firewall zone",
"example": "Hotspot|My custom zone",
"type": "string"
},
"networkIds": {
"description": "List of Network IDs",
"items": {
"example": "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b",
"format": "uuid",
"type": "string"
},
"minItems": 0,
"type": "array"
}
},
"required": [
"id",
"metadata",
"name",
"networkIds"
],
"type": "object"
},
"Firewall zones page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Firewall zone"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"Gateway Managed IPv4 Configuration": {
"properties": {
"additionalHostIpSubnets": {
"description": "Additional host IP subnets assigned to this VLAN.",
"items": {
"type": "string"
},
"maxItems": 64,
"minItems": 1,
"type": "array"
},
"autoScaleEnabled": {
"description": "Whether the Network can automatically scale its subnet size based on the number of active DHCP leases.",
"type": "boolean"
},
"dhcpConfiguration": {
"$ref": "#/components/schemas/Gateway Managed IPv4 DHCP Configuration",
"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."
},
"hostIpAddress": {
"type": "string"
},
"natOutboundIpAddressConfiguration": {
"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": {
"$ref": "#/components/schemas/WAN NAT Outbound Configuration"
},
"maxItems": 2147483647,
"minItems": 1,
"type": "array"
},
"prefixLength": {
"format": "int32",
"maximum": 30,
"minimum": 8,
"type": "integer"
}
},
"required": [
"autoScaleEnabled",
"hostIpAddress",
"prefixLength"
],
"type": "object"
},
"Gateway Managed IPv4 DHCP Configuration": {
"discriminator": {
"mapping": {
"RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration",
"SERVER": "#/components/schemas/Gateway Managed IPv4 DHCP Server Configuration"
},
"propertyName": "mode"
},
"properties": {
"mode": {
"type": "string"
}
},
"required": [
"mode"
]
},
"Gateway Managed IPv4 DHCP Server Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/Gateway Managed IPv4 DHCP Configuration"
},
{
"properties": {
"dnsServerIpAddressesOverride": {
"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,
"type": "array"
},
"domainName": {
"description": "Domain name that can be used to access network in the browser.",
"type": "string"
},
"gatewayIpAddressOverride": {
"description": "Gateway IP address provided to DHCP clients. If null, the default gateway will be assigned.",
"type": "string"
},
"ipAddressRange": {
"$ref": "#/components/schemas/IP address range"
},
"leaseTimeSeconds": {
"description": "The lease time in seconds for addresses in this range.",
"format": "int32",
"maximum": 31536000,
"minimum": 0,
"type": "integer"
},
"ntpServerIpAddresses": {
"description": "Network Time Protocol (NTP) server IP addresses.",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"type": "array"
},
"option43Value": {
"description": "Custom DHCP option (43) — the value MUST be the UniFi Network application's host IP address.",
"type": "string"
},
"pingConflictDetectionEnabled": {
"type": "boolean"
},
"pxeConfiguration": {
"$ref": "#/components/schemas/PXE Configuration",
"description": "Pre execution environment configuration for network boot"
},
"tftpServerAddress": {
"description": "Trivial File Transfer Protocol (TFTP) server address — accepts a hostname, URL or IP address.",
"type": "string"
},
"timeOffsetSeconds": {
"description": "Time offset in seconds from UTC.",
"format": "int32",
"maximum": 86400,
"minimum": -86400,
"type": "integer"
},
"winsServerIpAddresses": {
"description": "Windows Internet Name Service (WINS) server IP addresses.",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"type": "array"
},
"wpadUrl": {
"description": "Web Proxy Auto-Discovery (WPAD) URL.",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"ipAddressRange",
"leaseTimeSeconds",
"pingConflictDetectionEnabled"
]
},
"Gateway managed network details": {
"allOf": [
{
"$ref": "#/components/schemas/Network details"
},
{
"properties": {
"cellularBackupEnabled": {
"description": "Whether this network is allowed to use cellular data when WAN connection(s) are down.",
"type": "boolean"
},
"internetAccessEnabled": {
"description": "Whether the internet access is allowed for the device on this network.",
"type": "boolean"
},
"ipv4Configuration": {
"$ref": "#/components/schemas/Gateway Managed IPv4 Configuration",
"description": "Details about IPv4 configuration for this Network."
},
"ipv6Configuration": {
"$ref": "#/components/schemas/Network IPv6 Configuration",
"description": "Details about IPv6 configuration for this Network. If this field is omitted or null then IPv6 is not configured on this Network."
},
"isolationEnabled": {
"description": "Whether this network is isolated from all other networks.",
"type": "boolean"
},
"mdnsForwardingEnabled": {
"description": "Whether this network should participate in mDNS traffic forwarding.",
"type": "boolean"
},
"zoneId": {
"description": "Firewall zone ID associated with this Network.",
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"cellularBackupEnabled",
"default",
"enabled",
"id",
"internetAccessEnabled",
"ipv4Configuration",
"isolationEnabled",
"mdnsForwardingEnabled",
"metadata",
"name",
"vlanId"
]
},
"Gateway managed network overview": {
"allOf": [
{
"$ref": "#/components/schemas/Network overview"
},
{
"properties": {
"zoneId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"default",
"enabled",
"id",
"metadata",
"name",
"vlanId"
]
},
"Guest access authorization request": {
"allOf": [
{
"$ref": "#/components/schemas/Client action request"
},
{
"properties": {
"dataUsageLimitMBytes": {
"description": "(Optional) data usage limit in megabytes",
"format": "int64",
"maximum": 1048576,
"minimum": 1,
"type": "integer"
},
"rxRateLimitKbps": {
"description": "(Optional) download rate limit in kilobits per second",
"format": "int64",
"maximum": 100000,
"minimum": 2,
"type": "integer"
},
"timeLimitMinutes": {
"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",
"format": "int64",
"maximum": 1000000,
"minimum": 1,
"type": "integer"
},
"txRateLimitKbps": {
"description": "(Optional) upload rate limit in kilobits per second",
"format": "int64",
"maximum": 100000,
"minimum": 2,
"type": "integer"
}
},
"type": "object"
}
],
"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 authorization response": {
"allOf": [
{
"$ref": "#/components/schemas/Client action response"
},
{
"properties": {
"grantedAuthorization": {
"$ref": "#/components/schemas/Guest authorization details",
"description": "Granted guest authorization"
},
"revokedAuthorization": {
"$ref": "#/components/schemas/Guest authorization details",
"description": "(Optional) Revoked authorization in case the guest was already authorized at the time of this request"
}
},
"type": "object"
}
],
"required": [
"grantedAuthorization"
]
},
"Guest access details": {
"allOf": [
{
"$ref": "#/components/schemas/Local client access details"
},
{
"properties": {
"authorization": {
"$ref": "#/components/schemas/Guest authorization details"
},
"authorized": {
"type": "boolean"
}
},
"type": "object"
}
],
"required": [
"authorized"
]
},
"Guest access overview": {
"allOf": [
{
"$ref": "#/components/schemas/Local client access overview"
},
{
"properties": {
"authorized": {
"type": "boolean"
}
},
"type": "object"
}
],
"required": [
"authorized"
]
},
"Guest access unauthorization request": {
"allOf": [
{
"$ref": "#/components/schemas/Client action request"
}
],
"description": "Unauthorizes network access and disconnects a guest client."
},
"Guest access unauthorization response": {
"allOf": [
{
"$ref": "#/components/schemas/Client action response"
},
{
"properties": {
"revokedAuthorization": {
"$ref": "#/components/schemas/Guest authorization details",
"description": "Revoked guest authorization"
}
},
"type": "object"
}
],
"required": [
"revokedAuthorization"
]
},
"Guest authorization details": {
"properties": {
"authorizationMethod": {
"description": "Guest authorization method (API, Voucher etc)",
"enum": [
"VOUCHER",
"API",
"OTHER"
],
"type": "string"
},
"authorizedAt": {
"description": "Timestamp when the guest has been authorized",
"format": "date-time",
"type": "string"
},
"dataUsageLimitMBytes": {
"description": "(Optional) data usage limit in megabytes",
"example": 1024,
"format": "int64",
"type": "integer"
},
"expiresAt": {
"description": "Timestamp when the guest will get automatically unauthorized",
"format": "date-time",
"type": "string"
},
"rxRateLimitKbps": {
"description": "(Optional) download rate limit in kilobits per second",
"example": 1000,
"format": "int64",
"type": "integer"
},
"txRateLimitKbps": {
"description": "(Optional) upload rate limit in kilobits per second",
"example": 1000,
"format": "int64",
"type": "integer"
},
"usage": {
"$ref": "#/components/schemas/Guest authorization usage details"
}
},
"required": [
"authorizationMethod",
"authorizedAt",
"expiresAt"
],
"type": "object"
},
"Guest authorization usage details": {
"properties": {
"bytes": {
"format": "int64",
"type": "integer"
},
"durationSec": {
"format": "int64",
"type": "integer"
},
"rxBytes": {
"format": "int64",
"type": "integer"
},
"txBytes": {
"format": "int64",
"type": "integer"
}
},
"required": [
"bytes",
"durationSec",
"rxBytes",
"txBytes"
],
"type": "object"
},
"Hotspot voucher creation request": {
"properties": {
"authorizedGuestLimit": {
"description": "(Optional) limit for how many different guests can use the same voucher to authorize network access",
"example": 1,
"format": "int64",
"minimum": 1,
"type": "integer"
},
"count": {
"default": 1,
"description": "Number of vouchers to generate",
"format": "int32",
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"dataUsageLimitMBytes": {
"description": "(Optional) data usage limit in megabytes",
"format": "int64",
"maximum": 1048576,
"minimum": 1,
"type": "integer"
},
"name": {
"description": "Voucher note, duplicated across all generated vouchers",
"minLength": 1,
"type": "string"
},
"rxRateLimitKbps": {
"description": "(Optional) download rate limit in kilobits per second",
"format": "int64",
"maximum": 100000,
"minimum": 2,
"type": "integer"
},
"timeLimitMinutes": {
"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.",
"format": "int64",
"maximum": 1000000,
"minimum": 1,
"type": "integer"
},
"txRateLimitKbps": {
"description": "(Optional) upload rate limit in kilobits per second",
"format": "int64",
"maximum": 100000,
"minimum": 2,
"type": "integer"
}
},
"required": [
"name",
"timeLimitMinutes"
],
"type": "object"
},
"Hotspot voucher detail page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Hotspot voucher details"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"Hotspot voucher details": {
"properties": {
"activatedAt": {
"description": "(Optional) timestamp when the voucher has been activated (authorization time of the first guest)",
"format": "date-time",
"type": "string"
},
"authorizedGuestCount": {
"description": "For how many guests the voucher has been used to authorize network access",
"example": 0,
"format": "int64",
"type": "integer"
},
"authorizedGuestLimit": {
"description": "(Optional) limit for how many different guests can use the same voucher to authorize network access",
"example": 1,
"format": "int64",
"type": "integer"
},
"code": {
"description": "Secret code to active the voucher using the Hotspot portal",
"example": 4861409510,
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"dataUsageLimitMBytes": {
"description": "(Optional) data usage limit in megabytes",
"example": 1024,
"format": "int64",
"type": "integer"
},
"expired": {
"description": "Whether the voucher has been expired and can no longer be used to authorize network access",
"type": "boolean"
},
"expiresAt": {
"description": "(Optional) timestamp when the voucher will become expired. All guests using the voucher will be unauthorized from network access",
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"description": "Voucher note, may contain duplicate values across multiple vouchers",
"example": "hotel-guest",
"type": "string"
},
"rxRateLimitKbps": {
"description": "(Optional) download rate limit in kilobits per second",
"example": 1000,
"format": "int64",
"type": "integer"
},
"timeLimitMinutes": {
"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,
"format": "int64",
"type": "integer"
},
"txRateLimitKbps": {
"description": "(Optional) upload rate limit in kilobits per second",
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"authorizedGuestCount",
"code",
"createdAt",
"expired",
"id",
"name",
"timeLimitMinutes"
],
"type": "object"
},
"IP ACL rule endpoint": {
"discriminator": {
"mapping": {
"IP_ADDRESSES_OR_SUBNETS": "#/components/schemas/IntegrationIpAclRuleSubnetEndpointFilterDto",
"NETWORKS": "#/components/schemas/IntegrationIpAclRuleNetworkEndpointFilterDto",
"PORTS": "#/components/schemas/IntegrationIpAclRulePortEndpointFilterDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"IP Address selector": {
"allOf": [
{
"$ref": "#/components/schemas/IP address selector"
},
{
"properties": {
"value": {
"type": "string"
}
},
"type": "object"
}
],
"required": [
"value"
]
},
"IP address range": {
"properties": {
"start": {
"type": "string"
},
"stop": {
"type": "string"
}
},
"required": [
"start",
"stop"
],
"type": "object"
},
"IP address range selector": {
"allOf": [
{
"$ref": "#/components/schemas/IP address selector"
},
{
"properties": {
"start": {
"type": "string"
},
"stop": {
"type": "string"
}
},
"type": "object"
}
],
"required": [
"start",
"stop"
]
},
"IP address selector": {
"discriminator": {
"mapping": {
"IP_ADDRESS": "#/components/schemas/IP Address selector",
"IP_ADDRESS_RANGE": "#/components/schemas/IP address range selector"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"IP matching": {
"discriminator": {
"mapping": {
"IP_ADDRESS": "#/components/schemas/IntegrationFirewallPolicyIpMatchingIpAddressDto",
"IP_ADDRESS_RANGE": "#/components/schemas/IntegrationFirewallPolicyIpMatchingRangeDto",
"SUBNET": "#/components/schemas/IntegrationFirewallPolicyIpMatchingSubnetDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"IPv4 DHCP Relay Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/Gateway Managed IPv4 DHCP Configuration"
},
{
"properties": {
"dhcpServerIpAddresses": {
"description": "DHCP Server IP addresses",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/Switch Managed IPv4 DHCP Configuration"
}
],
"required": [
"dhcpServerIpAddresses"
]
},
"IPv4 DHCP Server Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/Switch Managed IPv4 DHCP Configuration"
},
{
"properties": {
"dnsServerIpAddressesOverride": {
"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,
"type": "array"
},
"domainName": {
"description": "Domain name that can be used to access network in the browser.",
"type": "string"
},
"gatewayIpAddressOverride": {
"description": "Gateway IP address provided to DHCP clients. If null, the default gateway will be assigned.",
"type": "string"
},
"ipAddressRange": {
"$ref": "#/components/schemas/IP address range"
},
"leaseTimeSeconds": {
"description": "The lease time in seconds for addresses in this range.",
"format": "int32",
"maximum": 31536000,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"ipAddressRange",
"leaseTimeSeconds"
]
},
"IPv4 matching": {
"discriminator": {
"mapping": {
"IP_ADDRESS": "#/components/schemas/Address IPv4 matching",
"IP_ADDRESS_RANGE": "#/components/schemas/Address range IPv4 matching",
"SUBNET": "#/components/schemas/Subnet IPv4 matching"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"IPv6 Client Address Assignment": {
"properties": {
"dhcpConfiguration": {
"$ref": "#/components/schemas/DHCP Configuration for IPv6 Network",
"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."
},
"slaacEnabled": {
"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.",
"type": "boolean"
}
},
"required": [
"slaacEnabled"
],
"type": "object"
},
"IPv6 Static Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/Network IPv6 Configuration"
},
{
"properties": {
"hostIpAddress": {
"description": "The static IPv6 address assigned to this Network.",
"type": "string"
},
"prefixLength": {
"format": "int32",
"maximum": 127,
"minimum": 64,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"clientAddressAssignment",
"hostIpAddress",
"prefixLength"
]
},
"IPv6 matching": {
"discriminator": {
"mapping": {
"IP_ADDRESS": "#/components/schemas/Address IPv6 matching",
"SUBNET": "#/components/schemas/Subnet IPv6 matching"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"IntegerType": {
"allOf": [
{
"$ref": "#/components/schemas/ScalarType"
}
]
},
"Integration blackout schedule configuration": {
"properties": {
"days": {
"items": {
"$ref": "#/components/schemas/Blackout schedule configuration per day"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"days"
],
"type": "object"
},
"IntegrationAclRuleDevicesFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/ACL rule device filter"
},
{
"properties": {
"deviceIds": {
"description": "List of Switch capable device IDs to which the ACL rule will be provisioned.",
"items": {
"format": "uuid",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
],
"required": [
"deviceIds"
]
},
"IntegrationAclRulePageDto": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/ACL ruleObject"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"IntegrationDerivedSiteToSiteTunnelMetadata": {
"allOf": [
{
"$ref": "#/components/schemas/Site-to-site VPN tunnel metadata"
},
{
"properties": {
"source": {
"enum": [
"SDWAN"
],
"type": "string"
}
},
"type": "object"
}
],
"required": [
"source"
]
},
"IntegrationDeviceAdoptionRequestDto": {
"properties": {
"ignoreDeviceLimit": {
"type": "boolean"
},
"macAddress": {
"type": "string"
}
},
"required": [
"ignoreDeviceLimit",
"macAddress"
],
"type": "object"
},
"IntegrationDeviceTagPageDto": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Device tag"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"IntegrationDnsARecordCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"ipv4Address": {
"example": "192.168.1.10",
"type": "string"
},
"ttlSeconds": {
"description": "Time to live in seconds.",
"example": 14400,
"format": "int32",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"ipv4Address",
"ttlSeconds"
]
},
"IntegrationDnsARecordDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"ipv4Address": {
"example": "192.168.1.10",
"type": "string"
},
"ttlSeconds": {
"description": "Time to live in seconds.",
"example": 14400,
"format": "int32",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"id",
"ipv4Address",
"metadata",
"ttlSeconds"
]
},
"IntegrationDnsAaaaRecordCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"ipv6Address": {
"example": "cafe::babe",
"type": "string"
},
"ttlSeconds": {
"description": "Time to live in seconds.",
"example": 14400,
"format": "int32",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"ipv6Address",
"ttlSeconds"
]
},
"IntegrationDnsAaaaRecordDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"ipv6Address": {
"example": "cafe::babe",
"type": "string"
},
"ttlSeconds": {
"description": "Time to live in seconds.",
"example": 14400,
"format": "int32",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"id",
"ipv6Address",
"metadata",
"ttlSeconds"
]
},
"IntegrationDnsCnameRecordCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"targetDomain": {
"example": "target.example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"ttlSeconds": {
"description": "Time to live in seconds.",
"example": 14400,
"format": "int32",
"maximum": 604800,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"targetDomain",
"ttlSeconds"
]
},
"IntegrationDnsCnameRecordDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"targetDomain": {
"example": "target.example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"ttlSeconds": {
"description": "Time to live in seconds.",
"example": 14400,
"format": "int32",
"maximum": 604800,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"id",
"metadata",
"targetDomain",
"ttlSeconds"
]
},
"IntegrationDnsForwardDomainPolicyCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"ipAddress": {
"description": "IP address of the DNS Server that the DNS query is forwarded to.",
"example": "8.8.4.4|2001:4860:4860::8844",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"ipAddress"
]
},
"IntegrationDnsForwardDomainPolicyDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"ipAddress": {
"description": "IP address of the DNS Server that the DNS query is forwarded to.",
"example": "8.8.4.4|2001:4860:4860::8844",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"id",
"ipAddress",
"metadata"
]
},
"IntegrationDnsMxRecordCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"mailServerDomain": {
"example": "mail.example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"priority": {
"description": "Priority. A lower number is preferred.",
"example": 255,
"format": "int32",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"mailServerDomain",
"priority"
]
},
"IntegrationDnsMxRecordDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"mailServerDomain": {
"example": "mail.example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"priority": {
"description": "Priority. A lower number is preferred.",
"example": 255,
"format": "int32",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"id",
"mailServerDomain",
"metadata",
"priority"
]
},
"IntegrationDnsPolicyPageDto": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/DNS policy"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"IntegrationDnsSrvRecordCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"port": {
"format": "int32",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"priority": {
"description": "Priority. A lower number is preferred.",
"example": 255,
"format": "int32",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"protocol": {
"description": "Protocol used by the service.",
"example": "_tcp",
"type": "string"
},
"serverDomain": {
"description": "Domain of the server that is running the service.",
"example": "server.example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"service": {
"description": "Service associated with this SRV record.",
"example": "_ldap",
"type": "string"
},
"weight": {
"description": "Weight. A relative value applicable for records with the same priority. A lower number is preferred.",
"example": 128,
"format": "int32",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"port",
"priority",
"protocol",
"serverDomain",
"service",
"weight"
]
},
"IntegrationDnsSrvRecordDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"port": {
"format": "int32",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"priority": {
"description": "Priority. A lower number is preferred.",
"example": 255,
"format": "int32",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"protocol": {
"description": "Protocol used by the service.",
"example": "_tcp",
"type": "string"
},
"serverDomain": {
"description": "Domain of the server that is running the service.",
"example": "server.example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"service": {
"description": "Service associated with this SRV record.",
"example": "_ldap",
"type": "string"
},
"weight": {
"description": "Weight. A relative value applicable for records with the same priority. A lower number is preferred.",
"example": 128,
"format": "int32",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"id",
"metadata",
"port",
"priority",
"protocol",
"serverDomain",
"service",
"weight"
]
},
"IntegrationDnsTxtRecordCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"text": {
"description": "The text value associated with this TXT DNS record. Text can contain up to four 255-character strings. Lines containing commas must be enclosed in double quotes (\").",
"example": "This is an example value of a TXT DNS Record.",
"maxLength": 1024,
"minLength": 1,
"type": "string"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"text"
]
},
"IntegrationDnsTxtRecordDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"properties": {
"domain": {
"example": "example.com",
"maxLength": 127,
"minLength": 1,
"type": "string"
},
"text": {
"description": "The text value associated with this TXT DNS record. Text can contain up to four 255-character strings. Lines containing commas must be enclosed in double quotes (\").",
"example": "This is an example value of a TXT DNS Record.",
"maxLength": 1024,
"minLength": 1,
"type": "string"
}
},
"type": "object"
}
],
"required": [
"domain",
"enabled",
"id",
"metadata",
"text"
]
},
"IntegrationFirewallPolicyActionAllowDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy action"
},
{
"properties": {
"allowReturnTraffic": {
"description": "Creates a derived policy for the mirrored firewall zone pair to automatically allow the return traffic.",
"type": "boolean"
}
},
"type": "object"
}
],
"required": [
"allowReturnTraffic"
]
},
"IntegrationFirewallPolicyActionBlockDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy action"
}
]
},
"IntegrationFirewallPolicyActionRejectDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy action"
}
]
},
"IntegrationFirewallPolicyDestinationApplicationCategoryFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"properties": {
"applicationCategoryFilter": {
"$ref": "#/components/schemas/Firewall policy application category filter",
"description": "Match destination traffic by DPI application categories."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic additionally by ports. If null, match all ports."
}
},
"type": "object"
}
],
"required": [
"applicationCategoryFilter"
]
},
"IntegrationFirewallPolicyDestinationApplicationFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"properties": {
"applicationFilter": {
"$ref": "#/components/schemas/Firewall policy application filter",
"description": "Match destination traffic by DPI applications."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic additionally by ports. If null, match all ports."
}
},
"type": "object"
}
],
"required": [
"applicationFilter"
]
},
"IntegrationFirewallPolicyDestinationDomainFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"properties": {
"domainFilter": {
"$ref": "#/components/schemas/Firewall policy domain filter",
"description": "Match destination traffic by domains."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic additionally by ports. If null, match all ports."
}
},
"type": "object"
}
],
"required": [
"domainFilter"
]
},
"IntegrationFirewallPolicyDestinationIpAddressFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"properties": {
"ipAddressFilter": {
"$ref": "#/components/schemas/Firewall policy IP address filter",
"description": "Match destination traffic by IP addresses."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic additionally by ports. If null, match all ports."
}
},
"type": "object"
}
],
"required": [
"ipAddressFilter"
]
},
"IntegrationFirewallPolicyDestinationIpv6IidFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"properties": {
"ipv6IidFilter": {
"$ref": "#/components/schemas/Firewall policy IPv6 interface identifier filter",
"description": "Match destination traffic by IPv6 interface identifier."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic additionally by ports. If null, match all ports."
}
},
"type": "object"
}
],
"required": [
"ipv6IidFilter"
]
},
"IntegrationFirewallPolicyDestinationNetworkFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"properties": {
"networkFilter": {
"$ref": "#/components/schemas/Firewall policy network filter",
"description": "Match destination traffic by networks."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic additionally by ports. If null, match all ports."
}
},
"type": "object"
}
],
"required": [
"networkFilter"
]
},
"IntegrationFirewallPolicyDestinationPortFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"properties": {
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic by ports."
}
},
"type": "object"
}
],
"required": [
"portFilter"
]
},
"IntegrationFirewallPolicyDestinationRegionFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"properties": {
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic additionally by ports. If null, match all ports."
},
"regionFilter": {
"$ref": "#/components/schemas/Firewall policy region filter",
"description": "Match destination traffic by regions."
}
},
"type": "object"
}
],
"required": [
"regionFilter"
]
},
"IntegrationFirewallPolicyDestinationSiteToSiteVpnTunnelFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"properties": {
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic additionally by ports. If null, match all ports."
},
"siteToSiteVpnTunnelFilter": {
"$ref": "#/components/schemas/Firewall policy site-to-site VPN tunnel filter",
"description": "Match destination traffic by site-to-site VPN tunnel."
}
},
"type": "object"
}
],
"required": [
"siteToSiteVpnTunnelFilter"
]
},
"IntegrationFirewallPolicyDestinationVpnServerFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"properties": {
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic additionally by ports. If null, match all ports."
},
"vpnServerFilter": {
"$ref": "#/components/schemas/Firewall policy VPN server filter",
"description": "Match destination traffic by VPN servers."
}
},
"type": "object"
}
],
"required": [
"vpnServerFilter"
]
},
"IntegrationFirewallPolicyIpAddressTrafficMatchingListFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IP address filter"
},
{
"properties": {
"trafficMatchingListId": {
"description": "ID of Traffic Matching List containing IP addresses to match.",
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"matchOpposite",
"trafficMatchingListId"
]
},
"IntegrationFirewallPolicyIpMatchingIpAddressDto": {
"allOf": [
{
"$ref": "#/components/schemas/IP matching"
},
{
"properties": {
"value": {
"description": "IP address to match.",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"value"
]
},
"IntegrationFirewallPolicyIpMatchingRangeDto": {
"allOf": [
{
"$ref": "#/components/schemas/IP matching"
},
{
"properties": {
"start": {
"description": "First IP address from range to match.",
"type": "string"
},
"stop": {
"description": "Last IP address from range to match.",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"start",
"stop"
]
},
"IntegrationFirewallPolicyIpMatchingSubnetDto": {
"allOf": [
{
"$ref": "#/components/schemas/IP matching"
},
{
"properties": {
"value": {
"description": "IP subnet in CIDR notation to match.",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"value"
]
},
"IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 named protocol"
}
],
"required": [
"name"
]
},
"IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 protocol"
},
{
"properties": {
"matchOpposite": {
"description": "Match on all protocols except the specified protocol.",
"type": "boolean"
},
"protocol": {
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 named protocol"
}
},
"type": "object"
}
],
"required": [
"matchOpposite",
"protocol"
]
},
"IntegrationFirewallPolicyIpv4AndIpv6ProtocolPresetFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 protocol"
},
{
"properties": {
"preset": {
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 protocol preset"
}
},
"type": "object"
}
],
"required": [
"preset"
]
},
"IntegrationFirewallPolicyIpv4AndIpv6ProtocolPresetTcpUdpDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 protocol preset"
}
]
},
"IntegrationFirewallPolicyIpv4AndIpv6ProtocolScopeDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IP protocol scope"
},
{
"properties": {
"protocolFilter": {
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 protocol"
}
},
"type": "object"
}
]
},
"IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 named protocol"
}
]
},
"IntegrationFirewallPolicyIpv4NamedProtocolFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 protocol"
},
{
"properties": {
"matchOpposite": {
"description": "Match on all protocols except the specified protocol.",
"type": "boolean"
},
"protocol": {
"$ref": "#/components/schemas/Firewall policy IPv4 named protocol"
}
},
"type": "object"
}
],
"required": [
"matchOpposite",
"protocol"
]
},
"IntegrationFirewallPolicyIpv4NamedProtocolIcmpDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 named protocol"
},
{
"properties": {
"typenameFilter": {
"description": "Match specific type of ICMP traffic. If null, matches all types.",
"enum": [
"ADDRESS_MASK_REPLY",
"ADDRESS_MASK_REQUEST",
"COMMUNICATION_PROHIBITED",
"DESTINATION_UNREACHABLE",
"ECHO_REPLY",
"ECHO_REQUEST",
"FRAGMENTATION_NEEDED",
"HOST_PRECEDENCE_VIOLATION",
"HOST_PROHIBITED",
"HOST_REDIRECT",
"HOST_UNKNOWN",
"HOST_UNREACHABLE",
"IP_HEADER_BAD",
"NETWORK_PROHIBITED",
"NETWORK_REDIRECT",
"NETWORK_UNKNOWN",
"NETWORK_UNREACHABLE",
"PARAMETER_PROBLEM",
"PORT_UNREACHABLE",
"PRECEDENCE_CUTOFF",
"PROTOCOL_UNREACHABLE",
"REDIRECT",
"REQUIRED_OPTION_MISSING",
"ROUTER_ADVERTISEMENT",
"ROUTER_SOLICITATION",
"SOURCE_QUENCH",
"SOURCE_ROUTE_FAILED",
"TIME_EXCEEDED",
"TIMESTAMP_REPLY",
"TIMESTAMP_REQUEST",
"TOS_HOST_REDIRECT",
"TOS_HOST_UNREACHABLE",
"TOS_NETWORK_REDIRECT",
"TOS_NETWORK_UNREACHABLE",
"TTL_ZERO_DURING_REASSEMBLY",
"TTL_ZERO_DURING_TRANSIT"
],
"type": "string"
}
},
"type": "object"
}
]
},
"IntegrationFirewallPolicyIpv4ProtocolPresetFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 protocol"
},
{
"properties": {
"preset": {
"$ref": "#/components/schemas/Firewall policy IPv4 protocol preset"
}
},
"type": "object"
}
],
"required": [
"preset"
]
},
"IntegrationFirewallPolicyIpv4ProtocolPresetTcpUdpDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 protocol preset"
}
]
},
"IntegrationFirewallPolicyIpv4ProtocolScopeDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IP protocol scope"
},
{
"properties": {
"protocolFilter": {
"$ref": "#/components/schemas/Firewall policy IPv4 protocol"
}
},
"type": "object"
}
]
},
"IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv6 named protocol"
}
]
},
"IntegrationFirewallPolicyIpv6NamedProtocolFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv6 protocol"
},
{
"properties": {
"matchOpposite": {
"description": "Match on all protocols except the specified protocol.",
"type": "boolean"
},
"protocol": {
"$ref": "#/components/schemas/Firewall policy IPv6 named protocol"
}
},
"type": "object"
}
],
"required": [
"matchOpposite",
"protocol"
]
},
"IntegrationFirewallPolicyIpv6NamedProtocolIcmpv6Dto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv6 named protocol"
},
{
"properties": {
"typenameFilter": {
"description": "Match specific type of ICMPv6 traffic. If null, matches all types.",
"enum": [
"ADDRESS_UNREACHABLE",
"BAD_HEADER",
"BEYOND_SCOPE",
"COMMUNICATION_PROHIBITED",
"DESTINATION_UNREACHABLE",
"ECHO_REPLY",
"ECHO_REQUEST",
"FAILED_POLICY",
"NEIGHBOR_ADVERTISEMENT",
"NEIGHBOR_SOLICITATION",
"NO_ROUTE",
"PACKET_TOO_BIG",
"PARAMETER_PROBLEM",
"PORT_UNREACHABLE",
"REDIRECT",
"REJECT_ROUTE",
"ROUTER_ADVERTISEMENT",
"ROUTER_SOLICITATION",
"TIME_EXCEEDED",
"TTL_ZERO_DURING_REASSEMBLY",
"TTL_ZERO_DURING_TRANSIT",
"UNKNOWN_HEADER_TYPE",
"UNKNOWN_OPTION"
],
"type": "string"
}
},
"type": "object"
}
]
},
"IntegrationFirewallPolicyIpv6ProtocolPresetFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv6 protocol"
},
{
"properties": {
"preset": {
"$ref": "#/components/schemas/Firewall policy IPv6 protocol preset"
}
},
"type": "object"
}
],
"required": [
"preset"
]
},
"IntegrationFirewallPolicyIpv6ProtocolPresetTcpUdpDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv6 protocol preset"
}
]
},
"IntegrationFirewallPolicyIpv6ProtocolScopeDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IP protocol scope"
},
{
"properties": {
"protocolFilter": {
"$ref": "#/components/schemas/Firewall policy IPv6 protocol"
}
},
"type": "object"
}
]
},
"IntegrationFirewallPolicyOrderingDto": {
"properties": {
"orderedFirewallPolicyIds": {
"$ref": "#/components/schemas/Ordered firewall policy IDs"
}
},
"required": [
"orderedFirewallPolicyIds"
],
"type": "object"
},
"IntegrationFirewallPolicyPortReferenceFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy port filter"
},
{
"properties": {
"trafficMatchingListId": {
"description": "ID of Traffic Matching List containing ports to match.",
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"matchOpposite",
"trafficMatchingListId"
]
},
"IntegrationFirewallPolicyPortValueFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy port filter"
},
{
"properties": {
"items": {
"description": "List of ports or port ranges to match.",
"items": {
"$ref": "#/components/schemas/Port matching"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
],
"required": [
"items",
"matchOpposite"
]
},
"IntegrationFirewallPolicySourceIpAddressFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"properties": {
"ipAddressFilter": {
"$ref": "#/components/schemas/Firewall policy IP address filter",
"description": "Match source traffic by IP addresses"
},
"macAddressFilter": {
"description": "Match source traffic additionally by a MAC address. If null, match all MAC addresses.",
"type": "string"
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic additionally by ports. If null, match all ports."
}
},
"type": "object"
}
],
"required": [
"ipAddressFilter"
]
},
"IntegrationFirewallPolicySourceIpv6IidFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"properties": {
"ipv6IidFilter": {
"$ref": "#/components/schemas/Firewall policy IPv6 interface identifier filter",
"description": "Match source traffic by IPv6 interface identifier"
},
"macAddressFilter": {
"description": "Match source traffic additionally by a MAC address. If null, match all MAC addresses.",
"type": "string"
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic additionally by ports. If null, match all ports."
}
},
"type": "object"
}
],
"required": [
"ipv6IidFilter"
]
},
"IntegrationFirewallPolicySourceMacAddressFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"properties": {
"macAddressFilter": {
"$ref": "#/components/schemas/Firewall policy MAC address filter",
"description": "Match source traffic by MAC addresses."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic additionally by ports. If null, match all ports."
}
},
"type": "object"
}
],
"required": [
"macAddressFilter"
]
},
"IntegrationFirewallPolicySourceNetworkFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"properties": {
"macAddressFilter": {
"description": "Match source traffic additionally by a MAC address. If null, match all MAC addresses.",
"type": "string"
},
"networkFilter": {
"$ref": "#/components/schemas/Firewall policy network filter",
"description": "Match source traffic by networks."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic additionally by ports. If null, match all ports."
}
},
"type": "object"
}
],
"required": [
"networkFilter"
]
},
"IntegrationFirewallPolicySourcePortFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"properties": {
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic by ports."
}
},
"type": "object"
}
],
"required": [
"portFilter"
]
},
"IntegrationFirewallPolicySourceRegionFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"properties": {
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic additionally by ports. If null, match all ports."
},
"regionFilter": {
"$ref": "#/components/schemas/Firewall policy region filter",
"description": "Match source traffic by regions."
}
},
"type": "object"
}
],
"required": [
"regionFilter"
]
},
"IntegrationFirewallPolicySourceSiteToSiteVpnTunnelFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"properties": {
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic additionally by ports. If null, match all ports."
},
"siteToSiteVpnTunnelFilter": {
"$ref": "#/components/schemas/Firewall policy site-to-site VPN tunnel filter",
"description": "Match source traffic by site-to-site VPN tunnel."
}
},
"type": "object"
}
],
"required": [
"siteToSiteVpnTunnelFilter"
]
},
"IntegrationFirewallPolicySourceVpnServerFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"properties": {
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic additionally by ports. If null, match all ports."
},
"vpnServerFilter": {
"$ref": "#/components/schemas/Firewall policy VPN server filter",
"description": "Match source traffic by VPN servers."
}
},
"type": "object"
}
],
"required": [
"vpnServerFilter"
]
},
"IntegrationFirewallPolicySpecificDomainFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy domain filter"
},
{
"properties": {
"domains": {
"description": "List of domains to match.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
],
"required": [
"domains"
]
},
"IntegrationFirewallPolicySpecificIpAddressFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IP address filter"
},
{
"properties": {
"items": {
"description": "List of IP addresses, IP address ranges, or IP subnets to match.",
"items": {
"$ref": "#/components/schemas/IP matching"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
],
"required": [
"items",
"matchOpposite"
]
},
"IntegrationFirewallScheduleCustomDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall schedule"
},
{
"properties": {
"repeatOnDays": {
"items": {
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"startDate": {
"description": "Date in YYYY-MM-DD format. ISO 8601 compliant.",
"example": "2025-12-31",
"format": "date",
"type": "string"
},
"stopDate": {
"description": "Date in YYYY-MM-DD format. ISO 8601 compliant.",
"example": "2025-12-31",
"format": "date",
"type": "string"
},
"timeFilter": {
"$ref": "#/components/schemas/Firewall schedule time"
}
},
"type": "object"
}
],
"required": [
"repeatOnDays",
"startDate",
"stopDate"
]
},
"IntegrationFirewallScheduleEveryDayDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall schedule"
},
{
"properties": {
"timeFilter": {
"$ref": "#/components/schemas/Firewall schedule time"
}
},
"type": "object"
}
],
"required": [
"timeFilter"
]
},
"IntegrationFirewallScheduleEveryWeekDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall schedule"
},
{
"properties": {
"repeatOnDays": {
"items": {
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"timeFilter": {
"$ref": "#/components/schemas/Firewall schedule time"
}
},
"type": "object"
}
],
"required": [
"repeatOnDays"
]
},
"IntegrationFirewallScheduleOneTimeOnlyDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall schedule"
},
{
"properties": {
"date": {
"description": "Date in YYYY-MM-DD format. ISO 8601 compliant.",
"example": "2025-12-31",
"format": "date",
"type": "string"
},
"timeFilter": {
"$ref": "#/components/schemas/Firewall schedule time"
}
},
"type": "object"
}
],
"required": [
"date",
"timeFilter"
]
},
"IntegrationGatewayManagedNetworkCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update Network"
},
{
"properties": {
"cellularBackupEnabled": {
"description": "Whether this network is allowed to use cellular data when WAN connection(s) are down.",
"type": "boolean"
},
"internetAccessEnabled": {
"description": "Whether the internet access is allowed for the device on this network.",
"type": "boolean"
},
"ipv4Configuration": {
"$ref": "#/components/schemas/Gateway Managed IPv4 Configuration",
"description": "Details about IPv4 configuration for this Network."
},
"ipv6Configuration": {
"$ref": "#/components/schemas/Network IPv6 Configuration",
"description": "Details about IPv6 configuration for this Network. If this field is omitted or null then IPv6 is not configured on this Network."
},
"isolationEnabled": {
"description": "Whether this network is isolated from all other networks.",
"type": "boolean"
},
"mdnsForwardingEnabled": {
"description": "Whether this network should participate in mDNS traffic forwarding. If null, the default from the site mDNS setting is used.",
"type": "boolean"
},
"zoneId": {
"description": "Firewall zone ID associated with this Network.",
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"cellularBackupEnabled",
"enabled",
"internetAccessEnabled",
"ipv4Configuration",
"isolationEnabled",
"name",
"vlanId"
]
},
"IntegrationIotOptimizedWifiBroadcastCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi broadcast create or update"
}
],
"required": [
"channel2gLockedTo6",
"clientIsolationEnabled",
"dtimPeriod2gLockedTo3",
"enabled",
"hideName",
"multicastToUnicastConversionEnabled",
"name",
"securityConfiguration",
"uapsdEnabled"
]
},
"IntegrationIotOptimizedWifiBroadcastDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi broadcast details"
}
],
"required": [
"channel2gLockedTo6",
"clientIsolationEnabled",
"dtimPeriod2gLockedTo3",
"enabled",
"hideName",
"id",
"metadata",
"multicastToUnicastConversionEnabled",
"name",
"securityConfiguration",
"uapsdEnabled"
]
},
"IntegrationIotOptimizedWifiBroadcastOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi broadcast overview"
}
],
"required": [
"enabled",
"id",
"metadata",
"name",
"securityConfiguration"
]
},
"IntegrationIpAclRuleCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/ACL rule update"
},
{
"properties": {
"destinationFilter": {
"$ref": "#/components/schemas/IP ACL rule endpoint",
"description": "Traffic destination filter"
},
"protocolFilter": {
"description": "Protocols this ACL rule will be applied to. When null, the rule will be applied to all protocols.",
"items": {
"enum": [
"TCP",
"UDP"
],
"type": "string"
},
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"sourceFilter": {
"$ref": "#/components/schemas/IP ACL rule endpoint",
"description": "Traffic source filter"
}
},
"type": "object"
}
],
"required": [
"action",
"enabled",
"name"
]
},
"IntegrationIpAclRuleDto": {
"allOf": [
{
"$ref": "#/components/schemas/ACL rule"
},
{
"properties": {
"destinationFilter": {
"$ref": "#/components/schemas/IP ACL rule endpoint",
"description": "Traffic destination filter"
},
"protocolFilter": {
"description": "Protocols this ACL rule will be applied to. When null, the rule will be applied to all protocols.",
"items": {
"enum": [
"TCP",
"UDP"
],
"type": "string"
},
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"sourceFilter": {
"$ref": "#/components/schemas/IP ACL rule endpoint",
"description": "Traffic source filter"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/ACL ruleObject"
}
],
"required": [
"action",
"enabled",
"id",
"index",
"metadata",
"name"
]
},
"IntegrationIpAclRuleNetworkEndpointFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/IP ACL rule endpoint"
},
{
"properties": {
"networkIds": {
"description": "Network IDs",
"items": {
"format": "uuid",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"portFilter": {
"description": "Ports this ACL rule will be applied to. If null, the rule will be applied to all ports.",
"items": {
"format": "int32",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"maxItems": 2147483647,
"maximum": 65535,
"minItems": 1,
"minimum": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
],
"required": [
"networkIds"
]
},
"IntegrationIpAclRulePortEndpointFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/IP ACL rule endpoint"
},
{
"properties": {
"portFilter": {
"description": "Ports this ACL rule will be applied to.",
"items": {
"format": "int32",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"maximum": 65535,
"minItems": 1,
"minimum": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
],
"required": [
"portFilter"
]
},
"IntegrationIpAclRuleSubnetEndpointFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/IP ACL rule endpoint"
},
{
"properties": {
"ipAddressesOrSubnets": {
"description": "IP addresses or subnets",
"items": {
"minLength": 1,
"type": "string"
},
"minItems": 1,
"type": "array"
},
"portFilter": {
"description": "Ports this ACL rule will be applied to. If null, all the rule will be applied to all ports.",
"items": {
"format": "int32",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"maxItems": 2147483647,
"maximum": 65535,
"minItems": 1,
"minimum": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
],
"required": [
"ipAddressesOrSubnets"
]
},
"IntegrationIpV4TrafficMatchingListCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update traffic matching list"
},
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/IPv4 matching"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
],
"required": [
"items",
"name"
]
},
"IntegrationIpV4TrafficMatchingListDto": {
"allOf": [
{
"$ref": "#/components/schemas/Traffic matching list"
},
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/IPv4 matching"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
],
"required": [
"id",
"items",
"name"
]
},
"IntegrationIpV6TrafficMatchingListCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update traffic matching list"
},
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/IPv6 matching"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
],
"required": [
"items",
"name"
]
},
"IntegrationIpV6TrafficMatchingListDto": {
"allOf": [
{
"$ref": "#/components/schemas/Traffic matching list"
},
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/IPv6 matching"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
],
"required": [
"id",
"items",
"name"
]
},
"IntegrationIpv6AddressSuffixRangeSelectorDto": {
"properties": {
"start": {
"description": "Start suffix of the DHCPv6 address pool.",
"type": "string"
},
"stop": {
"description": "End suffix of the DHCPv6 address pool.",
"type": "string"
}
},
"required": [
"start",
"stop"
],
"type": "object"
},
"IntegrationL2tpServerOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/VPN server overview"
}
],
"required": [
"enabled",
"id",
"metadata",
"name"
]
},
"IntegrationLagMemberDto": {
"properties": {
"deviceId": {
"format": "uuid",
"type": "string"
},
"portIdxs": {
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
}
},
"required": [
"deviceId",
"portIdxs"
],
"type": "object"
},
"IntegrationLagPageDto": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/LAG details"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"IntegrationLocalLagGlobalDto": {
"allOf": [
{
"$ref": "#/components/schemas/LAG details"
}
],
"required": [
"id",
"members",
"metadata"
]
},
"IntegrationLocalLagLocalDto": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/User defined entity metadata"
},
"portIdxs": {
"items": {
"format": "int32",
"type": "integer"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"id",
"metadata",
"portIdxs"
],
"type": "object"
},
"IntegrationMacAclRuleCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/ACL rule update"
},
{
"properties": {
"destinationFilter": {
"$ref": "#/components/schemas/MAC ACL rule endpoint",
"description": "Traffic destination filter"
},
"networkIdFilter": {
"description": "Network ID to which this ACL rule applies",
"format": "uuid",
"type": "string"
},
"sourceFilter": {
"$ref": "#/components/schemas/MAC ACL rule endpoint",
"description": "Traffic source filter"
}
},
"type": "object"
}
],
"required": [
"action",
"enabled",
"name",
"networkIdFilter"
]
},
"IntegrationMacAclRuleDto": {
"allOf": [
{
"$ref": "#/components/schemas/ACL rule"
},
{
"properties": {
"destinationFilter": {
"$ref": "#/components/schemas/MAC ACL rule endpoint",
"description": "Traffic destination filter"
},
"networkIdFilter": {
"description": "Network ID to which this ACL rule applies",
"format": "uuid",
"type": "string"
},
"sourceFilter": {
"$ref": "#/components/schemas/MAC ACL rule endpoint",
"description": "Traffic source filter"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/ACL ruleObject"
}
],
"required": [
"action",
"enabled",
"id",
"index",
"metadata",
"name",
"networkIdFilter"
]
},
"IntegrationMacAclRuleMacAddressEndpointFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/MAC ACL rule endpoint"
},
{
"properties": {
"macAddresses": {
"description": "Source/destination MAC addresses this ACL rule will apply to.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"prefixLength": {
"description": "MAC address prefix length. When null, full MAC address(-es) will be used.",
"format": "int32",
"maximum": 48,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"macAddresses"
]
},
"IntegrationMcLagDomainDto": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"lags": {
"items": {
"$ref": "#/components/schemas/IntegrationMcLagLocalDto"
},
"type": "array"
},
"metadata": {
"$ref": "#/components/schemas/User defined entity metadata"
},
"name": {
"type": "string"
},
"peers": {
"items": {
"$ref": "#/components/schemas/IntegrationMcLagPeerDto"
},
"type": "array"
}
},
"required": [
"id",
"lags",
"metadata",
"name",
"peers"
],
"type": "object"
},
"IntegrationMcLagDomainDtoPageDto": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/IntegrationMcLagDomainDto"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"IntegrationMcLagGlobalDto": {
"allOf": [
{
"$ref": "#/components/schemas/LAG details"
},
{
"properties": {
"mcLagDomainId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"id",
"mcLagDomainId",
"members",
"metadata"
]
},
"IntegrationMcLagLocalDto": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"members": {
"items": {
"$ref": "#/components/schemas/IntegrationLagMemberDto"
},
"type": "array"
},
"metadata": {
"$ref": "#/components/schemas/User defined entity metadata"
}
},
"required": [
"id",
"members",
"metadata"
],
"type": "object"
},
"IntegrationMcLagPeerDto": {
"properties": {
"deviceId": {
"format": "uuid",
"type": "string"
},
"linkPortIdxs": {
"items": {
"format": "int32",
"type": "integer"
},
"minItems": 1,
"type": "array"
},
"role": {
"enum": [
"TOP",
"BOTTOM"
],
"type": "string"
}
},
"required": [
"deviceId",
"linkPortIdxs",
"role"
],
"type": "object"
},
"IntegrationOpenVpnServerOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/VPN server overview"
}
],
"required": [
"enabled",
"id",
"metadata",
"name"
]
},
"IntegrationPortTrafficMatchingListCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update traffic matching list"
},
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Port matching"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
],
"required": [
"items",
"name"
]
},
"IntegrationPortTrafficMatchingListDto": {
"allOf": [
{
"$ref": "#/components/schemas/Traffic matching list"
},
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Port matching"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
],
"required": [
"id",
"items",
"name"
]
},
"IntegrationPptpServerOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/VPN server overview"
}
],
"required": [
"enabled",
"id",
"metadata",
"name"
]
},
"IntegrationSiteToSiteIpsecTunnelOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Site-to-site VPN tunnel overview"
}
],
"required": [
"id",
"metadata",
"name"
]
},
"IntegrationSiteToSiteOpenVpnTunnelOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Site-to-site VPN tunnel overview"
}
],
"required": [
"id",
"metadata",
"name"
]
},
"IntegrationSiteToSiteVpnTunnelOverviewPageDto": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Site-to-site VPN tunnel overview"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"IntegrationSiteToSiteWireguardTunnelOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Site-to-site VPN tunnel overview"
}
],
"required": [
"id",
"metadata",
"name"
]
},
"IntegrationStandardWifiBroadcastCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi broadcast create or update"
},
{
"properties": {
"advertiseDeviceName": {
"description": "Indicates whether the device name is advertised in beacon frames.",
"type": "boolean"
},
"arpProxyEnabled": {
"type": "boolean"
},
"bandSteeringEnabled": {
"type": "boolean"
},
"broadcastingFrequenciesGHz": {
"example": [
2.4,
5
],
"items": {
"enum": [
2.4,
5,
6
],
"type": "number"
},
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"bssTransitionEnabled": {
"type": "boolean"
},
"dnsAssistanceConfiguration": {
"$ref": "#/components/schemas/DNS assistance configuration"
},
"dtimPeriodByFrequencyGHzOverride": {
"$ref": "#/components/schemas/IntegrationWifiDtimPeriodConfigurationDto"
},
"handoffSuggestionsConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiHandoffSuggestionsConfigurationDto",
"description": "Suggests low-signal clients to roam to a better access point. If null, then it is disabled."
},
"hotspotConfiguration": {
"$ref": "#/components/schemas/Wifi hotspot configuration"
},
"mloEnabled": {
"type": "boolean"
}
},
"type": "object"
}
],
"required": [
"advertiseDeviceName",
"arpProxyEnabled",
"broadcastingFrequenciesGHz",
"bssTransitionEnabled",
"channel2gLockedTo6",
"clientIsolationEnabled",
"dtimPeriod2gLockedTo3",
"enabled",
"hideName",
"multicastToUnicastConversionEnabled",
"name",
"securityConfiguration",
"uapsdEnabled"
]
},
"IntegrationStandardWifiBroadcastDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi broadcast details"
},
{
"properties": {
"advertiseDeviceName": {
"description": "Indicates whether the device name is advertised in beacon frames.",
"type": "boolean"
},
"arpProxyEnabled": {
"type": "boolean"
},
"bandSteeringEnabled": {
"type": "boolean"
},
"broadcastingFrequenciesGHz": {
"example": [
2.4,
5
],
"items": {
"enum": [
2.4,
5,
6
],
"type": "number"
},
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"bssTransitionEnabled": {
"type": "boolean"
},
"dnsAssistanceConfiguration": {
"$ref": "#/components/schemas/DNS assistance configuration"
},
"dtimPeriodByFrequencyGHzOverride": {
"$ref": "#/components/schemas/IntegrationWifiDtimPeriodConfigurationDto"
},
"handoffSuggestionsConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiHandoffSuggestionsConfigurationDto",
"description": "Suggests low-signal clients to roam to a better access point. If null, then it is disabled."
},
"hotspotConfiguration": {
"$ref": "#/components/schemas/Wifi hotspot configuration"
},
"mloEnabled": {
"type": "boolean"
}
},
"type": "object"
}
],
"required": [
"advertiseDeviceName",
"arpProxyEnabled",
"broadcastingFrequenciesGHz",
"bssTransitionEnabled",
"channel2gLockedTo6",
"clientIsolationEnabled",
"dtimPeriod2gLockedTo3",
"enabled",
"hideName",
"id",
"metadata",
"multicastToUnicastConversionEnabled",
"name",
"securityConfiguration",
"uapsdEnabled"
]
},
"IntegrationStandardWifiBroadcastOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi broadcast overview"
},
{
"properties": {
"broadcastingFrequenciesGHz": {
"items": {
"enum": [
2.4,
5,
6
],
"type": "number"
},
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"hotspotConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiHotspotConfigurationOverviewDto"
}
},
"type": "object"
}
],
"required": [
"broadcastingFrequenciesGHz",
"enabled",
"id",
"metadata",
"name",
"securityConfiguration"
]
},
"IntegrationSwitchManagedNetworkCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update Network"
},
{
"properties": {
"cellularBackupEnabled": {
"description": "Whether this network is allowed to use cellular data when WAN connection(s) are down.",
"type": "boolean"
},
"deviceId": {
"description": "ID of the L3 switching capable device that manages this network.",
"format": "uuid",
"type": "string"
},
"ipv4Configuration": {
"$ref": "#/components/schemas/Switch Managed IPv4 Configuration",
"description": "Details about IPv4 configuration for this Network."
},
"isolationEnabled": {
"description": "Whether this network is isolated from all other networks.",
"type": "boolean"
}
},
"type": "object"
}
],
"required": [
"cellularBackupEnabled",
"deviceId",
"enabled",
"ipv4Configuration",
"isolationEnabled",
"name",
"vlanId"
]
},
"IntegrationSwitchStackDto": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"lags": {
"items": {
"$ref": "#/components/schemas/IntegrationSwitchStackLagLocalDto"
},
"type": "array"
},
"members": {
"items": {
"$ref": "#/components/schemas/IntegrationSwitchStackMemberDto"
},
"minItems": 2,
"type": "array"
},
"metadata": {
"$ref": "#/components/schemas/User defined entity metadata"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"lags",
"members",
"metadata",
"name"
],
"type": "object"
},
"IntegrationSwitchStackDtoPageDto": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/IntegrationSwitchStackDto"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"IntegrationSwitchStackLagGlobalDto": {
"allOf": [
{
"$ref": "#/components/schemas/LAG details"
},
{
"properties": {
"switchStackId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"id",
"members",
"metadata",
"switchStackId"
]
},
"IntegrationSwitchStackLagLocalDto": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"members": {
"items": {
"$ref": "#/components/schemas/IntegrationLagMemberDto"
},
"minItems": 1,
"type": "array"
},
"metadata": {
"$ref": "#/components/schemas/User defined entity metadata"
}
},
"required": [
"id",
"members",
"metadata"
],
"type": "object"
},
"IntegrationSwitchStackMemberDto": {
"properties": {
"deviceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"deviceId"
],
"type": "object"
},
"IntegrationUidVpnServerOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/VPN server overview"
}
],
"required": [
"enabled",
"id",
"metadata",
"name"
]
},
"IntegrationUnmanagedNetworkCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update Network"
}
],
"required": [
"enabled",
"name",
"vlanId"
]
},
"IntegrationVoucherCreationResultDto": {
"properties": {
"vouchers": {
"items": {
"$ref": "#/components/schemas/Hotspot voucher details"
},
"type": "array"
}
},
"type": "object"
},
"IntegrationVpnServerOverviewPageDto": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/VPN server overview"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"IntegrationWifiBasicDataRateConfigurationDto": {
"properties": {
"5": {
"enum": [
"6000",
"9000",
"12000",
"24000"
],
"example": 6000,
"format": "int32",
"type": "integer"
},
"2.4": {
"enum": [
"1000",
"2000",
"5500",
"6000",
"9000",
"11000",
"12000",
"24000"
],
"example": 2000,
"format": "int32",
"type": "integer"
}
},
"required": [
"2.4",
"5"
],
"type": "object"
},
"IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto": {
"allOf": [
{
"$ref": "#/components/schemas/Blackout schedule configuration per day"
}
],
"required": [
"day"
]
},
"IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto": {
"allOf": [
{
"$ref": "#/components/schemas/Blackout schedule configuration per day"
},
{
"properties": {
"timeRanges": {
"items": {
"$ref": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationTimeRangeDto"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
],
"required": [
"day",
"timeRanges"
]
},
"IntegrationWifiBlackoutScheduleConfigurationTimeRangeDto": {
"properties": {
"endTime": {
"description": "End time in 24-hour format (HH:mm)",
"type": "string"
},
"startTime": {
"description": "Start time in 24-hour format (HH:mm)",
"type": "string"
}
},
"required": [
"endTime",
"startTime"
],
"type": "object"
},
"IntegrationWifiBroadcastPageDto": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Wifi broadcast overview"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"IntegrationWifiCaptivePortalConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi hotspot configuration"
}
]
},
"IntegrationWifiClientFilteringPolicyDto": {
"properties": {
"action": {
"enum": [
"ALLOW",
"BLOCK"
],
"type": "string"
},
"macAddressFilter": {
"items": {
"type": "string"
},
"maxItems": 512,
"minItems": 0,
"type": "array",
"uniqueItems": true
}
},
"required": [
"action",
"macAddressFilter"
],
"type": "object"
},
"IntegrationWifiDerivedNasIdDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi Radius NAS ID configuration"
},
{
"properties": {
"source": {
"enum": [
"DEVICE_MAC_ADDRESS",
"DEVICE_NAME",
"SITE_NAME",
"BSSID"
],
"type": "string"
}
},
"type": "object"
}
],
"required": [
"source"
]
},
"IntegrationWifiDeviceTagsFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Broadcasting device filter"
},
{
"properties": {
"deviceTagIds": {
"items": {
"format": "uuid",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
],
"required": [
"deviceTagIds"
]
},
"IntegrationWifiDevicesFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Broadcasting device filter"
},
{
"properties": {
"deviceIds": {
"description": "List of Access Point capable device IDs to which the WiFi broadcast applies.",
"items": {
"format": "uuid",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
],
"required": [
"deviceIds"
]
},
"IntegrationWifiDnsAssistanceAutoConfigurationDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS assistance configuration"
}
]
},
"IntegrationWifiDnsAssistanceManualConfigurationDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS assistance configuration"
},
{
"properties": {
"servers": {
"items": {
"description": "Failover DNS servers",
"type": "string"
},
"maxItems": 2,
"minItems": 0,
"type": "array"
}
},
"type": "object"
}
],
"required": [
"servers"
]
},
"IntegrationWifiDtimPeriodConfigurationDto": {
"properties": {
"5": {
"format": "int32",
"maximum": 255,
"minimum": 1,
"type": "integer"
},
"6": {
"format": "int32",
"maximum": 255,
"minimum": 1,
"type": "integer"
},
"2.4": {
"description": "DTIM period for 2.4GHz band must be 3 when dtimPeriod2gLockedTo3 is enabled.",
"format": "int32",
"maximum": 255,
"minimum": 1,
"type": "integer"
}
},
"required": [
"2.4",
"5",
"6"
],
"type": "object"
},
"IntegrationWifiEnterpriseRadiusConfigurationDto": {
"properties": {
"macAuthenticationConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiRadiusMacAuthenticationConfigurationDto"
},
"nasId": {
"$ref": "#/components/schemas/Wifi Radius NAS ID configuration"
},
"profileId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"nasId",
"profileId"
],
"type": "object"
},
"IntegrationWifiHandoffSuggestionsConfigurationDto": {
"properties": {
"band5GHzRssiThreshold": {
"description": "RSSI threshold (dBm) for the 5 GHz band. If null, then it is disabled.",
"format": "int32",
"maximum": -60,
"minimum": -80,
"type": "integer"
},
"band6GHzRssiThreshold": {
"description": "RSSI threshold (dBm) for the 6 GHz band. If null, then it is disabled.",
"format": "int32",
"maximum": -70,
"minimum": -90,
"type": "integer"
}
},
"type": "object"
},
"IntegrationWifiHotspotConfigurationOverviewDto": {
"properties": {
"type": {
"enum": [
"CAPTIVE_PORTAL",
"PASSPOINT"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"IntegrationWifiMdnsProxyAllowPolicyDto": {
"allOf": [
{
"$ref": "#/components/schemas/mDNS proxy policy"
},
{
"properties": {
"bridgingNetworkIds": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"serviceFilter": {
"items": {
"$ref": "#/components/schemas/mDNS service"
},
"maxItems": 2147483647,
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
]
},
"IntegrationWifiMdnsProxyAutoConfigurationDto": {
"allOf": [
{
"$ref": "#/components/schemas/mDNS filtering configuration"
}
]
},
"IntegrationWifiMdnsProxyBlockPolicyDto": {
"allOf": [
{
"$ref": "#/components/schemas/mDNS proxy policy"
}
]
},
"IntegrationWifiMdnsProxyCustomConfigurationDto": {
"allOf": [
{
"$ref": "#/components/schemas/mDNS filtering configuration"
},
{
"properties": {
"policies": {
"items": {
"$ref": "#/components/schemas/mDNS proxy policy"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
],
"required": [
"policies"
]
},
"IntegrationWifiMdnsProxyCustomServiceDto": {
"allOf": [
{
"$ref": "#/components/schemas/mDNS service"
},
{
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"typeDomain": {
"minLength": 1,
"type": "string"
}
},
"type": "object"
}
],
"required": [
"name",
"typeDomain"
]
},
"IntegrationWifiMdnsProxyPredefinedServiceDto": {
"allOf": [
{
"$ref": "#/components/schemas/mDNS service"
},
{
"properties": {
"name": {
"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"
],
"type": "string"
}
},
"type": "object"
}
],
"required": [
"name"
]
},
"IntegrationWifiMulticastFilteringAllowPolicyDto": {
"allOf": [
{
"$ref": "#/components/schemas/Multicast filtering policy"
},
{
"properties": {
"sourceMacAddressFilter": {
"description": "List of multicast source MAC addresses allowed. Multicast traffic from gateways is always allowed.",
"items": {
"type": "string"
},
"maxItems": 256,
"minItems": 0,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
],
"required": [
"sourceMacAddressFilter"
]
},
"IntegrationWifiMulticastFilteringBlockPolicyDto": {
"allOf": [
{
"$ref": "#/components/schemas/Multicast filtering policy"
}
]
},
"IntegrationWifiNativeNetworkDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi network reference"
}
]
},
"IntegrationWifiNonEnterpriseRadiusConfigurationDto": {
"properties": {
"macAuthenticationConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiRadiusMacAuthenticationConfigurationDto"
},
"nasId": {
"$ref": "#/components/schemas/Wifi Radius NAS ID configuration"
},
"profileId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"macAuthenticationConfiguration",
"nasId",
"profileId"
],
"type": "object"
},
"IntegrationWifiOpenSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"properties": {
"encryption": {
"description": "Encryption mode for open security. If null, plain open with no encryption.",
"enum": [
"ENHANCED_OPEN",
"ENHANCED_OPEN_WITH_TRANSITION"
],
"type": "string"
},
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiNonEnterpriseRadiusConfigurationDto"
}
},
"type": "object"
}
]
},
"IntegrationWifiOpenSecurityConfigurationOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration overview"
}
]
},
"IntegrationWifiPasspointConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi hotspot configuration"
}
]
},
"IntegrationWifiPresharedKeyDto": {
"properties": {
"network": {
"$ref": "#/components/schemas/Wifi network reference"
},
"passphrase": {
"type": "string"
}
},
"required": [
"network",
"passphrase"
],
"type": "object"
},
"IntegrationWifiRadiusMacAuthenticationConfigurationDto": {
"properties": {
"macAddressFormat": {
"enum": [
"UPPERCASE_NOT_SEPARATED",
"UPPERCASE_DASH_SEPARATED",
"UPPERCASE_COLON_SEPARATED",
"LOWERCASE_NOT_SEPARATED",
"LOWERCASE_COLON_SEPARATED",
"LOWERCASE_DASH_SEPARATED"
],
"type": "string"
}
},
"required": [
"macAddressFormat"
],
"type": "object"
},
"IntegrationWifiSaeConfigurationDto": {
"properties": {
"anticloggingThresholdSeconds": {
"format": "int32",
"maximum": 60,
"minimum": 1,
"type": "integer"
},
"syncTimeSeconds": {
"format": "int32",
"maximum": 60,
"minimum": 1,
"type": "integer"
}
},
"required": [
"anticloggingThresholdSeconds",
"syncTimeSeconds"
],
"type": "object"
},
"IntegrationWifiSpecificNetworkDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi network reference"
},
{
"properties": {
"networkId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"networkId"
]
},
"IntegrationWifiUserDefinedNasIdDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi Radius NAS ID configuration"
},
{
"properties": {
"value": {
"type": "string"
}
},
"type": "object"
}
],
"required": [
"value"
]
},
"IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"properties": {
"coaEnabled": {
"description": "Indicates whether Change of Authorization (COA) is enabled",
"type": "boolean"
},
"fastRoamingEnabled": {
"description": "Fast roaming enabled flag. This feature is not available for IoT configuration.",
"type": "boolean"
},
"groupRekeyIntervalSeconds": {
"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.",
"format": "int32",
"maximum": 86400,
"minimum": 1,
"type": "integer"
},
"pmfMode": {
"description": "Protected Management Frames mode. If null, then it is disabled. This feature is not available for IoT configuration.",
"enum": [
"REQUIRED",
"OPTIONAL"
],
"type": "string"
},
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiEnterpriseRadiusConfigurationDto"
}
},
"type": "object"
}
],
"required": [
"coaEnabled",
"radiusConfiguration"
]
},
"IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration overview"
}
]
},
"IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"properties": {
"fastRoamingEnabled": {
"description": "Fast roaming enabled flag. This feature is not available for IoT configuration.",
"type": "boolean"
},
"groupRekeyIntervalSeconds": {
"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.",
"format": "int32",
"maximum": 86400,
"minimum": 1,
"type": "integer"
},
"passphrase": {
"maxLength": 63,
"minLength": 8,
"type": "string"
},
"pmfMode": {
"description": "Protected Management Frames mode. If null, then it is disabled. This feature is not available for IoT configuration.",
"enum": [
"REQUIRED",
"OPTIONAL"
],
"type": "string"
},
"presharedKeys": {
"items": {
"$ref": "#/components/schemas/IntegrationWifiPresharedKeyDto"
},
"maxItems": 2147483647,
"minItems": 1,
"type": "array"
},
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiNonEnterpriseRadiusConfigurationDto"
}
},
"type": "object"
}
]
},
"IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration overview"
},
{
"properties": {
"presharedKeyNetworkIds": {
"items": {
"$ref": "#/components/schemas/Wifi network reference"
},
"type": "array"
}
},
"type": "object"
}
]
},
"IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"properties": {
"coaEnabled": {
"description": "Indicates whether Change of Authorization (COA) is enabled",
"type": "boolean"
},
"fastRoamingEnabled": {
"description": "Fast roaming enabled flag. This feature is not available for IoT configuration.",
"type": "boolean"
},
"groupRekeyIntervalSeconds": {
"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.",
"format": "int32",
"maximum": 86400,
"minimum": 1,
"type": "integer"
},
"pmfMode": {
"description": "Protected Management Frames mode. If null, then it is disabled. This feature is not available for IoT configuration.",
"enum": [
"REQUIRED",
"OPTIONAL"
],
"type": "string"
},
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiEnterpriseRadiusConfigurationDto"
},
"wpa3FastRoamingEnabled": {
"description": "WPA3 fast roaming can be enabled only if the default fast roaming is enabled",
"type": "boolean"
}
},
"type": "object"
}
],
"required": [
"coaEnabled",
"pmfMode",
"radiusConfiguration",
"wpa3FastRoamingEnabled"
]
},
"IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration overview"
}
]
},
"IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"properties": {
"fastRoamingEnabled": {
"description": "Fast roaming enabled flag. This feature is not available for IoT configuration.",
"type": "boolean"
},
"groupRekeyIntervalSeconds": {
"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.",
"format": "int32",
"maximum": 86400,
"minimum": 1,
"type": "integer"
},
"passphrase": {
"maxLength": 63,
"minLength": 8,
"type": "string"
},
"pmfMode": {
"description": "Protected Management Frames mode. If null, then it is disabled. This feature is not available for IoT configuration.",
"enum": [
"REQUIRED",
"OPTIONAL"
],
"type": "string"
},
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiNonEnterpriseRadiusConfigurationDto"
},
"saeConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiSaeConfigurationDto",
"description": "Configuration for SAE (Simultaneous Authentication of Equals)."
},
"wpa3FastRoamingEnabled": {
"description": "WPA3 fast roaming can be enabled only if the default fast roaming is enabled",
"type": "boolean"
}
},
"type": "object"
}
],
"required": [
"passphrase",
"pmfMode",
"saeConfiguration",
"wpa3FastRoamingEnabled"
]
},
"IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration overview"
}
]
},
"IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"properties": {
"coaEnabled": {
"description": "Indicates whether Change of Authorization (COA) is enabled",
"type": "boolean"
},
"fastRoamingEnabled": {
"description": "Fast roaming enabled flag. This feature is not available for IoT configuration.",
"type": "boolean"
},
"groupRekeyIntervalSeconds": {
"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.",
"format": "int32",
"maximum": 86400,
"minimum": 1,
"type": "integer"
},
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiEnterpriseRadiusConfigurationDto"
},
"securityMode": {
"enum": [
"DEFAULT",
"HIGH_SECURITY_192_BIT"
],
"type": "string"
}
},
"type": "object"
}
],
"required": [
"coaEnabled",
"radiusConfiguration",
"securityMode"
]
},
"IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration overview"
}
]
},
"IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"properties": {
"fastRoamingEnabled": {
"description": "Fast roaming enabled flag. This feature is not available for IoT configuration.",
"type": "boolean"
},
"groupRekeyIntervalSeconds": {
"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.",
"format": "int32",
"maximum": 86400,
"minimum": 1,
"type": "integer"
},
"passphrase": {
"maxLength": 63,
"minLength": 8,
"type": "string"
},
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiNonEnterpriseRadiusConfigurationDto"
},
"saeConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiSaeConfigurationDto",
"description": "Configuration for SAE (Simultaneous Authentication of Equals)."
}
},
"type": "object"
}
],
"required": [
"passphrase",
"saeConfiguration"
]
},
"IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration overview"
}
]
},
"IntegrationWireguardServerOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/VPN server overview"
}
],
"required": [
"enabled",
"id",
"metadata",
"name"
]
},
"LAG details": {
"discriminator": {
"mapping": {
"LOCAL": "#/components/schemas/IntegrationLocalLagGlobalDto",
"MULTI_CHASSIS": "#/components/schemas/IntegrationMcLagGlobalDto",
"SWITCH_STACK": "#/components/schemas/IntegrationSwitchStackLagGlobalDto"
},
"propertyName": "type"
},
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"members": {
"items": {
"$ref": "#/components/schemas/IntegrationLagMemberDto"
},
"type": "array"
},
"metadata": {
"$ref": "#/components/schemas/User defined entity metadata"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"members",
"metadata",
"type"
],
"type": "object"
},
"Latest statistics for a device": {
"properties": {
"cpuUtilizationPct": {
"format": "double",
"type": "number"
},
"interfaces": {
"$ref": "#/components/schemas/Latest statistics for device interfaces"
},
"lastHeartbeatAt": {
"format": "date-time",
"type": "string"
},
"loadAverage15Min": {
"format": "double",
"type": "number"
},
"loadAverage1Min": {
"format": "double",
"type": "number"
},
"loadAverage5Min": {
"format": "double",
"type": "number"
},
"memoryUtilizationPct": {
"format": "double",
"type": "number"
},
"nextHeartbeatAt": {
"format": "date-time",
"type": "string"
},
"uplink": {
"$ref": "#/components/schemas/Latest statistics for a device uplink interface"
},
"uptimeSec": {
"format": "int64",
"type": "integer"
}
},
"required": [
"interfaces"
],
"type": "object"
},
"Latest statistics for a device uplink interface": {
"properties": {
"rxRateBps": {
"format": "int64",
"type": "integer"
},
"txRateBps": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"Latest statistics for device interfaces": {
"properties": {
"radios": {
"items": {
"$ref": "#/components/schemas/Latest statistics for wireless radio"
},
"type": "array"
}
},
"type": "object"
},
"Latest statistics for wireless radio": {
"properties": {
"frequencyGHz": {
"enum": [
2.4,
5,
6,
60
],
"type": "number"
},
"txRetriesPct": {
"format": "double",
"type": "number"
}
},
"required": [
"frequencyGHz"
],
"type": "object"
},
"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": {
"mapping": {
"DEFAULT": "#/components/schemas/Default client access details",
"GUEST": "#/components/schemas/Guest access details"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"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": {
"mapping": {
"DEFAULT": "#/components/schemas/Default client access overview",
"GUEST": "#/components/schemas/Guest access overview"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"MAC ACL rule endpoint": {
"discriminator": {
"mapping": {
"MAC_ADDRESSES": "#/components/schemas/IntegrationMacAclRuleMacAddressEndpointFilterDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Multicast filtering policy": {
"discriminator": {
"mapping": {
"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto",
"BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"
},
"propertyName": "action"
},
"properties": {
"action": {
"type": "string"
}
},
"required": [
"action"
]
},
"NAT Outbound Auto Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/WAN NAT Outbound Configuration"
},
{
"properties": {
"ipAddressSelectionMode": {
"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"
],
"type": "string"
}
},
"type": "object"
}
],
"required": [
"ipAddressSelectionMode",
"wanInterfaceId"
]
},
"NAT Outbound Static Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/WAN NAT Outbound Configuration"
},
{
"properties": {
"ipAddressSelectors": {
"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": {
"$ref": "#/components/schemas/IP address selector"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
],
"required": [
"ipAddressSelectors",
"wanInterfaceId"
]
},
"Network DHCP Guarding": {
"description": "Details about DHCP Guarding settings for this Network.",
"properties": {
"trustedDhcpServerIpAddresses": {
"description": "List of trusted DHCP server IP addresses.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"trustedDhcpServerIpAddresses"
],
"type": "object"
},
"Network IPv6 Configuration": {
"discriminator": {
"mapping": {
"PREFIX_DELEGATION": "#/components/schemas/Prefix delegation IPv6 Configuration",
"STATIC": "#/components/schemas/IPv6 Static Configuration"
},
"propertyName": "interfaceType"
},
"properties": {
"additionalHostIpSubnets": {
"description": "Additional host IP subnets assigned to this VLAN.",
"items": {
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"type": "array"
},
"clientAddressAssignment": {
"$ref": "#/components/schemas/IPv6 Client Address Assignment",
"description": "Client Address Assignment"
},
"dnsServerIpAddressesOverride": {
"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,
"type": "array"
},
"interfaceType": {
"type": "string"
},
"routerAdvertisement": {
"$ref": "#/components/schemas/Router advertisement Configuration",
"description": "Router advertisement. Without it, hosts will not autoconfigure addresses and will lack a default route even with DHCPv6."
}
},
"required": [
"clientAddressAssignment",
"interfaceType"
],
"type": "object"
},
"Network details": {
"discriminator": {
"mapping": {
"GATEWAY": "#/components/schemas/Gateway managed network details",
"SWITCH": "#/components/schemas/Switch managed network details",
"UNMANAGED": "#/components/schemas/Unmanaged network details"
},
"propertyName": "management"
},
"properties": {
"default": {
"type": "boolean"
},
"dhcpGuarding": {
"$ref": "#/components/schemas/Network DHCP Guarding",
"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"management": {
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/User or system defined or orchestrated entity metadata",
"description": "Orchestrated or System-defined configurable network support"
},
"name": {
"example": "Default Network",
"minLength": 1,
"type": "string"
},
"vlanId": {
"description": "VLAN ID. Must be 1 for the default network and >= 2 for additional networks.",
"format": "int32",
"maximum": 4009,
"minimum": 1,
"type": "integer"
}
},
"required": [
"default",
"enabled",
"id",
"management",
"metadata",
"name",
"vlanId"
],
"type": "object"
},
"Network overview": {
"discriminator": {
"mapping": {
"GATEWAY": "#/components/schemas/Gateway managed network overview",
"SWITCH": "#/components/schemas/Switch managed network overview",
"UNMANAGED": "#/components/schemas/Unmanaged network overview"
},
"propertyName": "management"
},
"properties": {
"default": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"management": {
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/User or system defined or orchestrated entity metadata",
"description": "Orchestrated or System-defined configurable network support"
},
"name": {
"example": "Default Network",
"type": "string"
},
"vlanId": {
"description": "VLAN ID. Must be 1 for the default network and >= 2 for additional networks.",
"format": "int32",
"maximum": 4009,
"minimum": 1,
"type": "integer"
}
},
"required": [
"default",
"enabled",
"id",
"management",
"metadata",
"name",
"vlanId"
],
"type": "object"
},
"Network overview page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Network overview"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"Network reference detail": {
"properties": {
"referenceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"referenceId"
],
"type": "object"
},
"Network reference resource": {
"properties": {
"referenceCount": {
"description": "Number of references of this type",
"format": "int32",
"minimum": 1,
"type": "integer"
},
"references": {
"description": "List of references, present only if resourceType has API model defined",
"items": {
"$ref": "#/components/schemas/Network reference detail"
},
"type": "array"
},
"resourceType": {
"enum": [
"CLIENT",
"DEVICE",
"STATIC_ROUTE",
"OSPF_ROUTE",
"NEXT_AI",
"WIFI",
"NAT_RULE",
"SD_WAN"
],
"type": "string"
}
},
"required": [
"referenceCount",
"resourceType"
],
"type": "object"
},
"Network references": {
"properties": {
"referenceResources": {
"description": "List of network reference resources",
"items": {
"$ref": "#/components/schemas/Network reference resource"
},
"type": "array"
}
},
"required": [
"referenceResources"
],
"type": "object"
},
"NotFilterExpression": {
"allOf": [
{
"$ref": "#/components/schemas/FilterExpression"
},
{
"properties": {
"expression": {}
},
"type": "object"
}
]
},
"Number port matching": {
"allOf": [
{
"$ref": "#/components/schemas/Port matching"
},
{
"properties": {
"value": {
"description": "Port number",
"example": "80|443|8080",
"format": "int32",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"value"
]
},
"Number range port matching": {
"allOf": [
{
"$ref": "#/components/schemas/Port matching"
},
{
"properties": {
"start": {
"description": "Start port number",
"example": "80|443|8080",
"format": "int32",
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"stop": {
"description": "Stop port number",
"example": "80|443|8080",
"format": "int32",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
}
],
"required": [
"start",
"stop"
]
},
"Orchestrated entity metadata": {
"allOf": [
{
"$ref": "#/components/schemas/Entity metadata"
}
]
},
"Ordered firewall policy IDs": {
"properties": {
"afterSystemDefined": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"beforeSystemDefined": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"afterSystemDefined",
"beforeSystemDefined"
],
"type": "object"
},
"PXE Configuration": {
"properties": {
"filename": {
"minLength": 1,
"type": "string"
},
"serverIpAddress": {
"type": "string"
}
},
"required": [
"filename",
"serverIpAddress"
],
"type": "object"
},
"Patch firewall policy": {
"properties": {
"loggingEnabled": {
"type": "boolean"
}
},
"type": "object"
},
"Port PoE overview": {
"properties": {
"enabled": {
"description": "Whether the PoE feature is enabled on the port",
"type": "boolean"
},
"standard": {
"enum": [
"802.3af",
"802.3at",
"802.3bt"
],
"example": "802.3bt",
"type": "string"
},
"state": {
"description": "Whether the port currently supplies power to the (connected) device.",
"enum": [
"UP",
"DOWN",
"LIMITED",
"UNKNOWN"
],
"type": "string"
},
"type": {
"enum": [
"1",
"2",
"3",
"4"
],
"example": 3,
"format": "int32",
"type": "integer"
}
},
"required": [
"enabled",
"standard",
"state",
"type"
],
"type": "object"
},
"Port PoE power-cycle request": {
"allOf": [
{
"$ref": "#/components/schemas/Port action request"
}
]
},
"Port action request": {
"discriminator": {
"mapping": {
"POWER_CYCLE": "#/components/schemas/Port PoE power-cycle request"
},
"propertyName": "action"
},
"properties": {
"action": {
"type": "string"
}
},
"required": [
"action"
]
},
"Port matching": {
"discriminator": {
"mapping": {
"PORT_NUMBER": "#/components/schemas/Number port matching",
"PORT_NUMBER_RANGE": "#/components/schemas/Number range port matching"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Port overview": {
"properties": {
"connector": {
"enum": [
"RJ45",
"SFP",
"SFPPLUS",
"SFP28",
"QSFP28"
],
"type": "string"
},
"idx": {
"example": 1,
"format": "int32",
"minimum": 1,
"type": "integer"
},
"maxSpeedMbps": {
"example": 10000,
"format": "int32",
"type": "integer"
},
"poe": {
"$ref": "#/components/schemas/Port PoE overview"
},
"speedMbps": {
"example": 1000,
"format": "int32",
"type": "integer"
},
"state": {
"enum": [
"UP",
"DOWN",
"UNKNOWN"
],
"type": "string"
}
},
"required": [
"connector",
"idx",
"maxSpeedMbps",
"state"
],
"type": "object"
},
"Prefix delegation IPv6 Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/Network IPv6 Configuration"
},
{
"properties": {
"prefixDelegationWanInterfaceId": {
"description": "ID of the WAN interface from which the prefix is delegated.",
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"clientAddressAssignment",
"prefixDelegationWanInterfaceId"
]
},
"PropertyFilterExpression": {
"allOf": [
{
"$ref": "#/components/schemas/FilterExpression"
},
{
"properties": {
"arguments": {
"items": {},
"type": "array"
},
"entity": {
"$ref": "#/components/schemas/FilterableEntity"
},
"function": {
"enum": [
"IS_NULL",
"IS_NOT_NULL",
"EQ",
"NE",
"GT",
"GE",
"LT",
"LE",
"LIKE",
"IN",
"NOT_IN",
"IS_EMPTY",
"CONTAINS",
"CONTAINS_ANY",
"CONTAINS_ALL",
"CONTAINS_EXACTLY"
],
"type": "string"
},
"property": {
"$ref": "#/components/schemas/FilterableProperty"
}
},
"type": "object"
}
]
},
"Radius Profile Overview": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/User or system defined or derived entity metadata"
},
"name": {
"minLength": 1,
"type": "string"
}
},
"required": [
"id",
"metadata",
"name"
],
"type": "object"
},
"Radius Profile Overview Page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Radius Profile Overview"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"Router advertisement Configuration": {
"properties": {
"priority": {
"description": "Router advertisement priority.",
"enum": [
"LOW",
"MEDIUM",
"HIGH"
],
"type": "string"
}
},
"required": [
"priority"
],
"type": "object"
},
"ScalarType": {
"allOf": [
{
"$ref": "#/components/schemas/FilterablePropertyType"
}
]
},
"SetType": {
"allOf": [
{
"$ref": "#/components/schemas/FilterablePropertyType"
}
]
},
"Site overview": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"internalReference": {
"description": "Internal unique name of the site used in older APIs",
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"internalReference",
"name"
],
"type": "object"
},
"Site overview page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Site overview"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"Site-to-site VPN tunnel metadata": {
"discriminator": {
"mapping": {
"DERIVED": "#/components/schemas/IntegrationDerivedSiteToSiteTunnelMetadata",
"USER_DEFINED": "#/components/schemas/User defined entity metadata"
},
"propertyName": "origin"
},
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
]
},
"Site-to-site VPN tunnel overview": {
"discriminator": {
"mapping": {
"IPSEC": "#/components/schemas/IntegrationSiteToSiteIpsecTunnelOverviewDto",
"OPENVPN": "#/components/schemas/IntegrationSiteToSiteOpenVpnTunnelOverviewDto",
"WIREGUARD": "#/components/schemas/IntegrationSiteToSiteWireguardTunnelOverviewDto"
},
"propertyName": "type"
},
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Site-to-site VPN tunnel metadata"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"metadata",
"name",
"type"
],
"type": "object"
},
"StringType": {
"allOf": [
{
"$ref": "#/components/schemas/ScalarType"
}
]
},
"Subnet IPv4 matching": {
"allOf": [
{
"$ref": "#/components/schemas/IPv4 matching"
},
{
"properties": {
"value": {
"description": "IPv4 subnet in CIDR notation",
"example": "192.168.1.0/24",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"value"
]
},
"Subnet IPv6 matching": {
"allOf": [
{
"$ref": "#/components/schemas/IPv6 matching"
},
{
"properties": {
"value": {
"description": "IPv6 subnet in CIDR notation",
"example": "2001:db8:1:0::/64",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"value"
]
},
"Switch Managed IPv4 Configuration": {
"properties": {
"additionalHostIpSubnets": {
"description": "Additional host IP subnets assigned to this VLAN.",
"items": {
"type": "string"
},
"maxItems": 64,
"minItems": 1,
"type": "array"
},
"autoScaleEnabled": {
"description": "Whether the Network can automatically scale its subnet size based on the number of active DHCP leases.",
"type": "boolean"
},
"dhcpConfiguration": {
"$ref": "#/components/schemas/Switch Managed IPv4 DHCP Configuration",
"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."
},
"hostIpAddress": {
"type": "string"
},
"prefixLength": {
"format": "int32",
"maximum": 30,
"minimum": 8,
"type": "integer"
}
},
"required": [
"autoScaleEnabled",
"hostIpAddress",
"prefixLength"
],
"type": "object"
},
"Switch Managed IPv4 DHCP Configuration": {
"discriminator": {
"mapping": {
"RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration",
"SERVER": "#/components/schemas/IPv4 DHCP Server Configuration"
},
"propertyName": "mode"
},
"properties": {
"mode": {
"type": "string"
}
},
"required": [
"mode"
]
},
"Switch managed network details": {
"allOf": [
{
"$ref": "#/components/schemas/Network details"
},
{
"properties": {
"cellularBackupEnabled": {
"description": "Whether this network is allowed to use cellular data when WAN connection(s) are down.",
"type": "boolean"
},
"deviceId": {
"description": "ID of the L3 switching capable device that manages this network.",
"format": "uuid",
"type": "string"
},
"ipv4Configuration": {
"$ref": "#/components/schemas/Switch Managed IPv4 Configuration",
"description": "Details about IPv4 configuration for this Network."
},
"isolationEnabled": {
"description": "Whether this network is isolated from all other networks.",
"type": "boolean"
}
},
"type": "object"
}
],
"required": [
"cellularBackupEnabled",
"default",
"deviceId",
"enabled",
"id",
"ipv4Configuration",
"isolationEnabled",
"metadata",
"name",
"vlanId"
]
},
"Switch managed network overview": {
"allOf": [
{
"$ref": "#/components/schemas/Network overview"
},
{
"properties": {
"deviceId": {
"description": "ID of the switch this Network is managed by.",
"example": "550e8400-e29b-41d4-a716-446655440000",
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"default",
"deviceId",
"enabled",
"id",
"metadata",
"name",
"vlanId"
]
},
"Switching feature overview": {
"properties": {
"lags": {
"items": {
"$ref": "#/components/schemas/IntegrationLocalLagLocalDto"
},
"type": "array"
}
},
"required": [
"lags"
],
"type": "object"
},
"System defined entity metadata": {
"allOf": [
{
"$ref": "#/components/schemas/Entity metadata"
}
]
},
"Teleport client (connection) details": {
"properties": {
"access": {
"$ref": "#/components/schemas/Teleport client access details"
},
"connectedAt": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"ipAddress": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"access",
"id",
"name"
],
"type": "object"
},
"Teleport client (connection) overview": {
"allOf": [
{
"$ref": "#/components/schemas/Client overview"
},
{
"properties": {
"access": {
"$ref": "#/components/schemas/Teleport client access overview"
}
},
"type": "object"
}
],
"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": {
"mapping": {
"DEFAULT": "#/components/schemas/Default client access details"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"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": {
"mapping": {
"DEFAULT": "#/components/schemas/Default client access overview"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"TimestampType": {
"allOf": [
{
"$ref": "#/components/schemas/ScalarType"
}
]
},
"Traffic matching list": {
"discriminator": {
"mapping": {
"IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListDto",
"IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListDto",
"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListDto"
},
"propertyName": "type"
},
"properties": {
"id": {
"example": "ffcdb32c-6278-4364-8947-df4f77118df8",
"format": "uuid",
"type": "string"
},
"name": {
"example": "Allowed port list|Protected IP list",
"minLength": 1,
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"name",
"type"
],
"type": "object"
},
"Traffic matching lists page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Traffic matching list"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"UUIDType": {
"allOf": [
{
"$ref": "#/components/schemas/ScalarType"
}
]
},
"Unmanaged network details": {
"allOf": [
{
"$ref": "#/components/schemas/Network details"
}
],
"required": [
"default",
"enabled",
"id",
"metadata",
"name",
"vlanId"
]
},
"Unmanaged network overview": {
"allOf": [
{
"$ref": "#/components/schemas/Network overview"
}
],
"required": [
"default",
"enabled",
"id",
"metadata",
"name",
"vlanId"
]
},
"User defined entity metadata": {
"allOf": [
{
"$ref": "#/components/schemas/Entity metadata"
},
{
"$ref": "#/components/schemas/User or system defined entity metadata"
},
{
"$ref": "#/components/schemas/User defined or derived entity metadata"
},
{
"$ref": "#/components/schemas/User or system defined or orchestrated entity metadata"
},
{
"$ref": "#/components/schemas/User or orchestrated entity metadata"
},
{
"$ref": "#/components/schemas/User or derived or orchestrated entity metadata"
},
{
"$ref": "#/components/schemas/Site-to-site VPN tunnel metadata"
}
]
},
"User defined or derived entity metadata": {
"discriminator": {
"mapping": {
"DERIVED": "#/components/schemas/Derived entity metadata",
"USER_DEFINED": "#/components/schemas/User defined entity metadata"
},
"propertyName": "origin"
},
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
]
},
"User or derived or orchestrated entity metadata": {
"discriminator": {
"mapping": {
"DERIVED": "#/components/schemas/Derived entity metadata",
"ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata",
"USER_DEFINED": "#/components/schemas/User defined entity metadata"
},
"propertyName": "origin"
},
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
]
},
"User or orchestrated entity metadata": {
"discriminator": {
"mapping": {
"ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata",
"USER_DEFINED": "#/components/schemas/User defined entity metadata"
},
"propertyName": "origin"
},
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
]
},
"User or system defined entity metadata": {
"discriminator": {
"mapping": {
"SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata",
"USER_DEFINED": "#/components/schemas/User defined entity metadata"
},
"propertyName": "origin"
},
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
]
},
"User or system defined or derived entity metadata": {
"discriminator": {
"mapping": {
"DERIVED": "#/components/schemas/Derived entity metadata",
"SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata",
"USER_DEFINED": "#/components/schemas/User defined entity metadata"
},
"propertyName": "origin"
},
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
]
},
"User or system defined or orchestrated entity metadata": {
"discriminator": {
"mapping": {
"ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata",
"SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata",
"USER_DEFINED": "#/components/schemas/User defined entity metadata"
},
"propertyName": "origin"
},
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
]
},
"VPN client (connection) details": {
"allOf": [
{
"$ref": "#/components/schemas/Client details"
},
{
"properties": {
"access": {
"$ref": "#/components/schemas/VPN client access details"
}
},
"type": "object"
}
],
"required": [
"access",
"id",
"name"
]
},
"VPN client (connection) overview": {
"allOf": [
{
"$ref": "#/components/schemas/Client overview"
},
{
"properties": {
"access": {
"$ref": "#/components/schemas/VPN client access overview"
}
},
"type": "object"
}
],
"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": {
"mapping": {
"DEFAULT": "#/components/schemas/Default client access details"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"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": {
"mapping": {
"DEFAULT": "#/components/schemas/Default client access overview"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"VPN server overview": {
"discriminator": {
"mapping": {
"L2TP": "#/components/schemas/IntegrationL2tpServerOverviewDto",
"OPENVPN": "#/components/schemas/IntegrationOpenVpnServerOverviewDto",
"PPTP": "#/components/schemas/IntegrationPptpServerOverviewDto",
"UID": "#/components/schemas/IntegrationUidVpnServerOverviewDto",
"WIREGUARD": "#/components/schemas/IntegrationWireguardServerOverviewDto"
},
"propertyName": "type"
},
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/User defined or derived entity metadata"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"enabled",
"id",
"metadata",
"name",
"type"
],
"type": "object"
},
"Voucher deletion results": {
"properties": {
"vouchersDeleted": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"WAN NAT Outbound Configuration": {
"discriminator": {
"mapping": {
"AUTO": "#/components/schemas/NAT Outbound Auto Configuration",
"STATIC": "#/components/schemas/NAT Outbound Static Configuration"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
},
"wanInterfaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"type",
"wanInterfaceId"
],
"type": "object"
},
"WAN overview": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"example": "Internet 1",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"WAN overview page": {
"properties": {
"count": {
"example": 10,
"format": "int32",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/WAN overview"
},
"type": "array"
},
"limit": {
"example": 25,
"format": "int32",
"type": "integer"
},
"offset": {
"example": 0,
"format": "int64",
"type": "integer"
},
"totalCount": {
"example": 1000,
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
],
"type": "object"
},
"Wifi Radius NAS ID configuration": {
"discriminator": {
"mapping": {
"DERIVED": "#/components/schemas/IntegrationWifiDerivedNasIdDto",
"USER_DEFINED": "#/components/schemas/IntegrationWifiUserDefinedNasIdDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Wifi broadcast create or update": {
"discriminator": {
"mapping": {
"IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastCreateUpdateDto",
"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastCreateUpdateDto"
},
"propertyName": "type"
},
"properties": {
"basicDataRateKbpsByFrequencyGHz": {
"$ref": "#/components/schemas/IntegrationWifiBasicDataRateConfigurationDto"
},
"blackoutScheduleConfiguration": {
"$ref": "#/components/schemas/Integration blackout schedule configuration"
},
"broadcastingDeviceFilter": {
"$ref": "#/components/schemas/Broadcasting device filter",
"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."
},
"channel2gLockedTo6": {
"default": false,
"description": "Locks 2.4GHz radio channel to 6 on all broadcasting devices",
"type": "boolean"
},
"clientFilteringPolicy": {
"$ref": "#/components/schemas/IntegrationWifiClientFilteringPolicyDto",
"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses."
},
"clientIsolationEnabled": {
"type": "boolean"
},
"dtimPeriod2gLockedTo3": {
"default": false,
"description": "Locks DTIM period to 3 for 2.4GHz radio",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"hideName": {
"type": "boolean"
},
"mdnsProxyConfiguration": {
"$ref": "#/components/schemas/mDNS filtering configuration"
},
"multicastFilteringPolicy": {
"$ref": "#/components/schemas/Multicast filtering policy"
},
"multicastToUnicastConversionEnabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"network": {
"$ref": "#/components/schemas/Wifi network reference"
},
"securityConfiguration": {
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
"type": {
"type": "string"
},
"uapsdEnabled": {
"description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled",
"type": "boolean"
}
},
"required": [
"channel2gLockedTo6",
"clientIsolationEnabled",
"dtimPeriod2gLockedTo3",
"enabled",
"hideName",
"multicastToUnicastConversionEnabled",
"name",
"securityConfiguration",
"type",
"uapsdEnabled"
],
"type": "object"
},
"Wifi broadcast details": {
"discriminator": {
"mapping": {
"IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastDetailDto",
"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastDetailDto"
},
"propertyName": "type"
},
"properties": {
"basicDataRateKbpsByFrequencyGHz": {
"$ref": "#/components/schemas/IntegrationWifiBasicDataRateConfigurationDto"
},
"blackoutScheduleConfiguration": {
"$ref": "#/components/schemas/Integration blackout schedule configuration"
},
"broadcastingDeviceFilter": {
"$ref": "#/components/schemas/Broadcasting device filter",
"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."
},
"channel2gLockedTo6": {
"description": "Locks 2.4GHz radio channel to 6 on all broadcasting devices",
"type": "boolean"
},
"clientFilteringPolicy": {
"$ref": "#/components/schemas/IntegrationWifiClientFilteringPolicyDto",
"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses."
},
"clientIsolationEnabled": {
"type": "boolean"
},
"dtimPeriod2gLockedTo3": {
"description": "Locks DTIM period to 3 for 2.4GHz radio",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"hideName": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"mdnsProxyConfiguration": {
"$ref": "#/components/schemas/mDNS filtering configuration"
},
"metadata": {
"$ref": "#/components/schemas/User or derived or orchestrated entity metadata"
},
"multicastFilteringPolicy": {
"$ref": "#/components/schemas/Multicast filtering policy"
},
"multicastToUnicastConversionEnabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"network": {
"$ref": "#/components/schemas/Wifi network reference"
},
"securityConfiguration": {
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
"type": {
"type": "string"
},
"uapsdEnabled": {
"description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled",
"type": "boolean"
}
},
"required": [
"channel2gLockedTo6",
"clientIsolationEnabled",
"dtimPeriod2gLockedTo3",
"enabled",
"hideName",
"id",
"metadata",
"multicastToUnicastConversionEnabled",
"name",
"securityConfiguration",
"type",
"uapsdEnabled"
],
"type": "object"
},
"Wifi broadcast overview": {
"discriminator": {
"mapping": {
"IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastOverviewDto",
"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastOverviewDto"
},
"propertyName": "type"
},
"properties": {
"broadcastingDeviceFilter": {
"$ref": "#/components/schemas/Broadcasting device filter",
"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."
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/User or derived or orchestrated entity metadata"
},
"name": {
"type": "string"
},
"network": {
"$ref": "#/components/schemas/Wifi network reference"
},
"securityConfiguration": {
"$ref": "#/components/schemas/Wifi security configuration overview"
},
"type": {
"type": "string"
}
},
"required": [
"enabled",
"id",
"metadata",
"name",
"securityConfiguration",
"type"
],
"type": "object"
},
"Wifi hotspot configuration": {
"discriminator": {
"mapping": {
"CAPTIVE_PORTAL": "#/components/schemas/IntegrationWifiCaptivePortalConfigurationDetailDto",
"PASSPOINT": "#/components/schemas/IntegrationWifiPasspointConfigurationDetailDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Wifi network reference": {
"discriminator": {
"mapping": {
"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto",
"SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Wifi security configuration detailObject": {
"discriminator": {
"mapping": {
"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto",
"WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto",
"WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto",
"WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto",
"WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto",
"WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto",
"WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto"
},
"propertyName": "type"
},
"properties": {
"radiusConfiguration": {},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Wifi security configuration overview": {
"discriminator": {
"mapping": {
"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto",
"WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto",
"WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto",
"WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto",
"WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto",
"WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto",
"WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
},
"Wired client details": {
"allOf": [
{
"$ref": "#/components/schemas/Client details"
},
{
"properties": {
"access": {
"$ref": "#/components/schemas/Local client access details"
},
"macAddress": {
"type": "string"
},
"uplinkDeviceId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"access",
"id",
"macAddress",
"name",
"uplinkDeviceId"
]
},
"Wired client overview": {
"allOf": [
{
"$ref": "#/components/schemas/Client overview"
},
{
"properties": {
"access": {
"$ref": "#/components/schemas/Local client access overview"
},
"macAddress": {
"type": "string"
},
"uplinkDeviceId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"access",
"id",
"macAddress",
"name",
"uplinkDeviceId"
]
},
"Wireless client details": {
"allOf": [
{
"$ref": "#/components/schemas/Client details"
},
{
"properties": {
"access": {
"$ref": "#/components/schemas/Local client access details"
},
"macAddress": {
"type": "string"
},
"uplinkDeviceId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"access",
"id",
"macAddress",
"name",
"uplinkDeviceId"
]
},
"Wireless client overview": {
"allOf": [
{
"$ref": "#/components/schemas/Client overview"
},
{
"properties": {
"access": {
"$ref": "#/components/schemas/Local client access overview"
},
"macAddress": {
"type": "string"
},
"uplinkDeviceId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"access",
"id",
"macAddress",
"name",
"uplinkDeviceId"
]
},
"Wireless radio overview": {
"properties": {
"channel": {
"example": 36,
"format": "int32",
"type": "integer"
},
"channelWidthMHz": {
"example": 40,
"format": "int32",
"type": "integer"
},
"frequencyGHz": {
"enum": [
2.4,
5,
6,
60
],
"type": "number"
},
"wlanStandard": {
"enum": [
"802.11a",
"802.11b",
"802.11g",
"802.11n",
"802.11ac",
"802.11ax",
"802.11be"
],
"type": "string"
}
},
"required": [
"channelWidthMHz",
"frequencyGHz",
"wlanStandard"
],
"type": "object"
},
"mDNS filtering configuration": {
"discriminator": {
"mapping": {
"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto",
"CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"
},
"propertyName": "mode"
},
"properties": {
"mode": {
"type": "string"
}
},
"required": [
"mode"
]
},
"mDNS proxy policy": {
"discriminator": {
"mapping": {
"ALLOW": "#/components/schemas/IntegrationWifiMdnsProxyAllowPolicyDto",
"BLOCK": "#/components/schemas/IntegrationWifiMdnsProxyBlockPolicyDto"
},
"propertyName": "action"
},
"properties": {
"action": {
"type": "string"
},
"deviceFilter": {
"$ref": "#/components/schemas/Broadcasting device filter",
"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."
}
},
"required": [
"action"
],
"type": "object"
},
"mDNS service": {
"discriminator": {
"mapping": {
"CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomServiceDto",
"PREDEFINED": "#/components/schemas/IntegrationWifiMdnsProxyPredefinedServiceDto"
},
"propertyName": "type"
},
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
}
}
},
"info": {
"description": "",
"license": {},
"title": "UniFi Network API",
"version": "10.4.57"
},
"openapi": "3.1.0",
"paths": {
"/v1/countries": {
"get": {
"description": "Returns ISO-standard country codes and names,\nused for region-based configuration or regulatory compliance.\n\n\nFilterable properties (click to expand)
\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`code`|`STRING`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n ",
"operationId": "getCountries",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Country definition page"
}
}
},
"description": "OK"
}
},
"summary": "List Countries",
"tags": [
"Supporting Resources"
]
}
},
"/v1/dpi/applications": {
"get": {
"description": "Lists DPI-recognized applications grouped under categories. Useful for firewall or traffic analytics integration.\n\n\nFilterable properties (click to expand)
\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`INTEGER`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n ",
"operationId": "getDpiApplications",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DPI application page"
}
}
},
"description": "OK"
}
},
"summary": "List DPI Applications",
"tags": [
"Supporting Resources"
]
}
},
"/v1/dpi/categories": {
"get": {
"description": "Returns predefined Deep Packet Inspection (DPI) application categories used for traffic identification and filtering.\n\n\nFilterable properties (click to expand)
\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`INTEGER`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n ",
"operationId": "getDpiApplicationCategories",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DPI category page"
}
}
},
"description": "OK"
}
},
"summary": "List DPI Application Categories",
"tags": [
"Supporting Resources"
]
}
},
"/v1/info": {
"get": {
"description": "Retrieve general information about the UniFi Network application.",
"operationId": "getInfo",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Application info"
}
}
},
"description": "OK"
}
},
"summary": "Get Application Info",
"tags": [
"Application Info"
]
}
},
"/v1/pending-devices": {
"get": {
"description": "Retrieve a paginated list of devices pending adoption, including basic device information.\n\n\nFilterable properties (click to expand)
\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 ",
"operationId": "getPendingDevicePage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Device pending adoption page"
}
}
},
"description": "OK"
}
},
"summary": "List Devices Pending Adoption",
"tags": [
"UniFi Devices"
]
}
},
"/v1/sites": {
"get": {
"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\nFilterable properties (click to expand)
\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 ",
"operationId": "getSiteOverviewPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site overview page"
}
}
},
"description": "OK"
}
},
"summary": "List Local Sites",
"tags": [
"Sites"
]
}
},
"/v1/sites/{siteId}/acl-rules": {
"get": {
"description": "Retrieve a paginated list of all ACL rules on a site.\n\n\nFilterable properties (click to expand)
\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`enabled`|`BOOLEAN`|`eq` `ne`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`description`|`STRING`|`isNull` `isNotNull` `eq` `ne` `in` `notIn` `like`|\n|`action`|`STRING`|`eq` `ne` `in` `notIn`|\n|`index`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le` `in` `notIn`|\n|`protocolFilter`|`SET(STRING)`|`isNull` `isNotNull` `contains` `containsAny` `containsAll` `containsExactly`|\n|`networkId`|`UUID`|`isNull` `isNotNull` `eq` `ne` `in` `notIn`|\n|`enforcingDeviceFilter.deviceIds`|`SET(UUID)`|`isNull` `isNotNull` `contains` `containsAny` `containsAll` `containsExactly`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n|`sourceFilter.type`|`STRING`|`isNull` `isNotNull` `eq` `ne` `in` `notIn`|\n|`sourceFilter.ipAddressesOrSubnets`|`SET(STRING)`|`contains` `containsAny` `containsAll` `containsExactly`|\n|`sourceFilter.portFilter`|`SET(INTEGER)`|`isNull` `isNotNull` `contains` `containsAny` `containsAll` `containsExactly`|\n|`sourceFilter.networkIds`|`SET(UUID)`|`contains` `containsAny` `containsAll` `containsExactly`|\n|`sourceFilter.macAddresses`|`SET(STRING)`|`contains` `containsAny` `containsAll` `containsExactly`|\n|`sourceFilter.prefixLength`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le` `in` `notIn`|\n|`destinationFilter.type`|`STRING`|`isNull` `isNotNull` `eq` `ne` `in` `notIn`|\n|`destinationFilter.ipAddressesOrSubnets`|`SET(STRING)`|`contains` `containsAny` `containsAll` `containsExactly`|\n|`destinationFilter.portFilter`|`SET(INTEGER)`|`isNull` `isNotNull` `contains` `containsAny` `containsAll` `containsExactly`|\n|`destinationFilter.networkIds`|`SET(UUID)`|`contains` `containsAny` `containsAll` `containsExactly`|\n|`destinationFilter.macAddresses`|`SET(STRING)`|`contains` `containsAny` `containsAll` `containsExactly`|\n|`destinationFilter.prefixLength`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le` `in` `notIn`|\n ",
"operationId": "getAclRulePage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationAclRulePageDto"
}
}
},
"description": "OK"
}
},
"summary": "List ACL Rules",
"tags": [
"Access Control (ACL Rules)"
]
},
"post": {
"description": "Create a new user defined ACL rule on a site.",
"operationId": "createAclRule",
"parameters": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule update"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule"
}
}
},
"description": "Created"
}
},
"summary": "Create ACL Rule",
"tags": [
"Access Control (ACL Rules)"
]
}
},
"/v1/sites/{siteId}/acl-rules/ordering": {
"get": {
"description": "Retrieve user-defined ACL rule ordering on a site.",
"operationId": "getAclRuleOrdering",
"parameters": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule ordering"
}
}
},
"description": "OK"
}
},
"summary": "Get User-Defined ACL Rule Ordering",
"tags": [
"Access Control (ACL Rules)"
]
},
"put": {
"description": "Reorder user-defined ACL rules on a site.",
"operationId": "updateAclRuleOrdering",
"parameters": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule ordering"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule ordering"
}
}
},
"description": "OK"
}
},
"summary": "Reorder User-Defined ACL Rules",
"tags": [
"Access Control (ACL Rules)"
]
}
},
"/v1/sites/{siteId}/acl-rules/{aclRuleId}": {
"delete": {
"description": "Delete an existing user defined ACL rule on a site.",
"operationId": "deleteAclRule",
"parameters": [
{
"in": "path",
"name": "aclRuleId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Delete ACL Rule",
"tags": [
"Access Control (ACL Rules)"
]
},
"get": {
"operationId": "getAclRule",
"parameters": [
{
"in": "path",
"name": "aclRuleId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule"
}
}
},
"description": "OK"
}
},
"summary": "Get ACL Rule",
"tags": [
"Access Control (ACL Rules)"
]
},
"put": {
"description": "Update an existing user defined ACL rule on a site.",
"operationId": "updateAclRule",
"parameters": [
{
"in": "path",
"name": "aclRuleId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule update"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule"
}
}
},
"description": "OK"
}
},
"summary": "Update ACL Rule",
"tags": [
"Access Control (ACL Rules)"
]
}
},
"/v1/sites/{siteId}/clients": {
"get": {
"description": "Retrieve a paginated list of all connected clients on a site, including physical devices (computers, smartphones) and active VPN connections.\n\n\nFilterable properties (click to expand)
\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 ",
"operationId": "getConnectedClientOverviewPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client overview page"
}
}
},
"description": "OK"
}
},
"summary": "List Connected Clients",
"tags": [
"Clients"
]
}
},
"/v1/sites/{siteId}/clients/{clientId}": {
"get": {
"description": "Retrieve detailed information about a specific connected client, including name, IP address, MAC address, connection type and access information.",
"operationId": "getConnectedClientDetails",
"parameters": [
{
"in": "path",
"name": "clientId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client details"
}
}
},
"description": "OK"
}
},
"summary": "Get Connected Client Details",
"tags": [
"Clients"
]
}
},
"/v1/sites/{siteId}/clients/{clientId}/actions": {
"post": {
"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": [
{
"in": "path",
"name": "clientId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client action request"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client action response"
}
}
},
"description": "OK"
}
},
"summary": "Execute Client Action",
"tags": [
"Clients"
]
}
},
"/v1/sites/{siteId}/device-tags": {
"get": {
"description": "Returns all device tags defined within a site, which can be used for WiFi Broadcast assignments.\n\n\nFilterable properties (click to expand)
\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 ",
"operationId": "getDeviceTagPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/components/schemas/FilterExpression"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationDeviceTagPageDto"
}
}
},
"description": "OK"
}
},
"summary": "List Device Tags",
"tags": [
"Supporting Resources"
]
}
},
"/v1/sites/{siteId}/devices": {
"get": {
"description": "Retrieve a paginated list of all adopted devices on a site, including basic device information.\n\n\nFilterable properties (click to expand)
\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 ",
"operationId": "getAdoptedDeviceOverviewPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Adopted device overview page"
}
}
},
"description": "OK"
}
},
"summary": "List Adopted Devices",
"tags": [
"UniFi Devices"
]
},
"post": {
"description": "Adopt a device to a site.",
"operationId": "adoptDevice",
"parameters": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationDeviceAdoptionRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Adopted device details"
}
}
},
"description": "OK"
}
},
"summary": "Adopt Devices",
"tags": [
"UniFi Devices"
]
}
},
"/v1/sites/{siteId}/devices/{deviceId}": {
"delete": {
"description": "Removes (unadopts) an adopted device from the site. If the device is online, it will be reset to factory defaults.",
"operationId": "removeDevice",
"parameters": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "deviceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Remove (Unadopt) Device",
"tags": [
"UniFi Devices"
]
},
"get": {
"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": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "deviceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Adopted device details"
}
}
},
"description": "OK"
}
},
"summary": "Get Adopted Device Details",
"tags": [
"UniFi Devices"
]
}
},
"/v1/sites/{siteId}/devices/{deviceId}/actions": {
"post": {
"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": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "deviceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Device action request"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Execute Adopted Device Action",
"tags": [
"UniFi Devices"
]
}
},
"/v1/sites/{siteId}/devices/{deviceId}/interfaces/ports/{portIdx}/actions": {
"post": {
"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": [
{
"in": "path",
"name": "portIdx",
"required": true,
"schema": {
"format": "int32",
"type": "integer"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "deviceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Port action request"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Execute Port Action",
"tags": [
"UniFi Devices"
]
}
},
"/v1/sites/{siteId}/devices/{deviceId}/statistics/latest": {
"get": {
"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": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "deviceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Latest statistics for a device"
}
}
},
"description": "OK"
}
},
"summary": "Get Latest Adopted Device Statistics",
"tags": [
"UniFi Devices"
]
}
},
"/v1/sites/{siteId}/dns/policies": {
"get": {
"description": "Retrieve a paginated list of all DNS policies on a site.\n\n\nFilterable properties (click to expand)
\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`enabled`|`BOOLEAN`|`eq` `ne`|\n|`domain`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`ipv4Address`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`ipv6Address`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`targetDomain`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`mailServerDomain`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`text`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`serverDomain`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`ipAddress`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`ttlSeconds`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le` `in` `notIn`|\n|`priority`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le` `in` `notIn`|\n|`service`|`STRING`|`eq` `ne` `in` `notIn`|\n|`protocol`|`STRING`|`eq` `ne` `in` `notIn`|\n|`port`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le` `in` `notIn`|\n|`weight`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le` `in` `notIn`|\n ",
"operationId": "getDnsPolicyPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationDnsPolicyPageDto"
}
}
},
"description": "OK"
}
},
"summary": "List DNS Policies",
"tags": [
"DNS Policies"
]
},
"post": {
"description": "Create a new DNS policy on a site.",
"operationId": "createDnsPolicy",
"parameters": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update DNS policy"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DNS policy"
}
}
},
"description": "Created"
}
},
"summary": "Create DNS Policy",
"tags": [
"DNS Policies"
]
}
},
"/v1/sites/{siteId}/dns/policies/{dnsPolicyId}": {
"delete": {
"description": "Delete an existing DNS policy on a site.",
"operationId": "deleteDnsPolicy",
"parameters": [
{
"in": "path",
"name": "dnsPolicyId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Delete DNS Policy",
"tags": [
"DNS Policies"
]
},
"get": {
"description": "Retrieve specific DNS policy.",
"operationId": "getDnsPolicy",
"parameters": [
{
"in": "path",
"name": "dnsPolicyId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DNS policy"
}
}
},
"description": "OK"
}
},
"summary": "Get DNS Policy",
"tags": [
"DNS Policies"
]
},
"put": {
"description": "Update an existing DNS policy on a site.",
"operationId": "updateDnsPolicy",
"parameters": [
{
"in": "path",
"name": "dnsPolicyId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update DNS policy"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DNS policy"
}
}
},
"description": "OK"
}
},
"summary": "Update DNS Policy",
"tags": [
"DNS Policies"
]
}
},
"/v1/sites/{siteId}/firewall/policies": {
"get": {
"description": "Retrieve a list of all firewall policies on a site.\n\n\nFilterable properties (click to expand)
\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`source.zoneId`|`UUID`|`eq` `ne` `in` `notIn`|\n|`destination.zoneId`|`UUID`|`eq` `ne` `in` `notIn`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n ",
"operationId": "getFirewallPolicies",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall policy page"
}
}
},
"description": "OK"
}
},
"summary": "List Firewall Policies",
"tags": [
"Firewall"
]
},
"post": {
"description": "Create a new firewall policy on a site.",
"operationId": "createFirewallPolicy",
"parameters": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update firewall policy"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall policy"
}
}
},
"description": "Created"
}
},
"summary": "Create Firewall Policy",
"tags": [
"Firewall"
]
}
},
"/v1/sites/{siteId}/firewall/policies/ordering": {
"get": {
"description": "Retrieve user-defined firewall policy ordering for a specific source/destination zone pair.",
"operationId": "getFirewallPolicyOrdering",
"parameters": [
{
"in": "query",
"name": "sourceFirewallZoneId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "destinationFirewallZoneId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationFirewallPolicyOrderingDto"
}
}
},
"description": "OK"
}
},
"summary": "Get User-Defined Firewall Policy Ordering",
"tags": [
"Firewall"
]
},
"put": {
"description": "Reorder user-defined firewall policies for a specific source/destination zone pair.",
"operationId": "updateFirewallPolicyOrdering",
"parameters": [
{
"in": "query",
"name": "sourceFirewallZoneId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "destinationFirewallZoneId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationFirewallPolicyOrderingDto"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationFirewallPolicyOrderingDto"
}
}
},
"description": "OK"
}
},
"summary": "Reorder User-Defined Firewall Policies",
"tags": [
"Firewall"
]
}
},
"/v1/sites/{siteId}/firewall/policies/{firewallPolicyId}": {
"delete": {
"description": "Delete an existing firewall policy on a site.",
"operationId": "deleteFirewallPolicy",
"parameters": [
{
"in": "path",
"name": "firewallPolicyId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Delete Firewall Policy",
"tags": [
"Firewall"
]
},
"get": {
"description": "Retrieve specific firewall policy.",
"operationId": "getFirewallPolicy",
"parameters": [
{
"in": "path",
"name": "firewallPolicyId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall policy"
}
}
},
"description": "OK"
}
},
"summary": "Get Firewall Policy",
"tags": [
"Firewall"
]
},
"patch": {
"description": "Patch an existing firewall policy on a site.",
"operationId": "patchFirewallPolicy",
"parameters": [
{
"in": "path",
"name": "firewallPolicyId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Patch firewall policy"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall policy"
}
}
},
"description": "OK"
}
},
"summary": "Patch Firewall Policy",
"tags": [
"Firewall"
]
},
"put": {
"description": "Update an existing firewall policy on a site.",
"operationId": "updateFirewallPolicy",
"parameters": [
{
"in": "path",
"name": "firewallPolicyId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update firewall policy"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall policy"
}
}
},
"description": "OK"
}
},
"summary": "Update Firewall Policy",
"tags": [
"Firewall"
]
}
},
"/v1/sites/{siteId}/firewall/zones": {
"get": {
"description": "Retrieve a list of all firewall zones on a site.\n\n\nFilterable properties (click to expand)
\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 ",
"operationId": "getFirewallZones",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall zones page"
}
}
},
"description": "OK"
}
},
"summary": "List Firewall Zones",
"tags": [
"Firewall"
]
},
"post": {
"description": "Create a new custom firewall zone on a site.",
"operationId": "createFirewallZone",
"parameters": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update firewall zone"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall zone"
}
}
},
"description": "Created"
}
},
"summary": "Create Custom Firewall Zone",
"tags": [
"Firewall"
]
}
},
"/v1/sites/{siteId}/firewall/zones/{firewallZoneId}": {
"delete": {
"description": "Delete a custom firewall zone from a site.",
"operationId": "deleteFirewallZone",
"parameters": [
{
"in": "path",
"name": "firewallZoneId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Delete Custom Firewall Zone",
"tags": [
"Firewall"
]
},
"get": {
"description": "Get a firewall zone on a site.",
"operationId": "getFirewallZone",
"parameters": [
{
"in": "path",
"name": "firewallZoneId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall zone"
}
}
},
"description": "OK"
}
},
"summary": "Get Firewall Zone",
"tags": [
"Firewall"
]
},
"put": {
"description": "Update a firewall zone on a site.",
"operationId": "updateFirewallZone",
"parameters": [
{
"in": "path",
"name": "firewallZoneId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update firewall zone"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall zone"
}
}
},
"description": "OK"
}
},
"summary": "Update Firewall Zone",
"tags": [
"Firewall"
]
}
},
"/v1/sites/{siteId}/hotspot/vouchers": {
"delete": {
"description": "Remove Hotspot vouchers based on the specified filter criteria.\n\n\nFilterable properties (click to expand)
\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 ",
"operationId": "deleteVouchers",
"parameters": [
{
"in": "query",
"name": "filter",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Voucher deletion results"
}
}
},
"description": "OK"
}
},
"summary": "Delete Vouchers",
"tags": [
"Hotspot"
]
},
"get": {
"description": "Retrieve a paginated list of Hotspot vouchers.\n\n\nFilterable properties (click to expand)
\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 ",
"operationId": "getVouchers",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 100,
"format": "int32",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Hotspot voucher detail page"
}
}
},
"description": "OK"
}
},
"summary": "List Vouchers",
"tags": [
"Hotspot"
]
},
"post": {
"description": "Create one or more Hotspot vouchers.",
"operationId": "createVouchers",
"parameters": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Hotspot voucher creation request"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationVoucherCreationResultDto"
}
}
},
"description": "Created"
}
},
"summary": "Generate Vouchers",
"tags": [
"Hotspot"
]
}
},
"/v1/sites/{siteId}/hotspot/vouchers/{voucherId}": {
"delete": {
"description": "Remove a specific Hotspot voucher.",
"operationId": "deleteVoucher",
"parameters": [
{
"in": "path",
"name": "voucherId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Voucher deletion results"
}
}
},
"description": "OK"
}
},
"summary": "Delete Voucher",
"tags": [
"Hotspot"
]
},
"get": {
"description": "Retrieve details of a specific Hotspot voucher.",
"operationId": "getVoucher",
"parameters": [
{
"in": "path",
"name": "voucherId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Hotspot voucher details"
}
}
},
"description": "OK"
}
},
"summary": "Get Voucher Details",
"tags": [
"Hotspot"
]
}
},
"/v1/sites/{siteId}/networks": {
"get": {
"description": "Retrieve a paginated list of all Networks on a site.\n\n\nFilterable properties (click to expand)
\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 ",
"operationId": "getNetworksOverviewPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Network overview page"
}
}
},
"description": "OK"
}
},
"summary": "List Networks",
"tags": [
"Networks"
]
},
"post": {
"description": "Create a new network on a site.",
"operationId": "createNetwork",
"parameters": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update Network"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Network details"
}
}
},
"description": "Created"
}
},
"summary": "Create Network",
"tags": [
"Networks"
]
}
},
"/v1/sites/{siteId}/networks/{networkId}": {
"delete": {
"description": "Delete an existing network on a site.",
"operationId": "deleteNetwork",
"parameters": [
{
"in": "path",
"name": "networkId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "force",
"required": false,
"schema": {
"default": false,
"type": "boolean"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Delete Network",
"tags": [
"Networks"
]
},
"get": {
"description": "Retrieve detailed information about a specific network.",
"operationId": "getNetworkDetails",
"parameters": [
{
"in": "path",
"name": "networkId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Network details"
}
}
},
"description": "OK"
}
},
"summary": "Get Network Details",
"tags": [
"Networks"
]
},
"put": {
"description": "Update an existing network on a site.",
"operationId": "updateNetwork",
"parameters": [
{
"in": "path",
"name": "networkId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update Network"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Network details"
}
}
},
"description": "OK"
}
},
"summary": "Update Network",
"tags": [
"Networks"
]
}
},
"/v1/sites/{siteId}/networks/{networkId}/references": {
"get": {
"description": "Retrieve references to a specific network.",
"operationId": "getNetworkReferences",
"parameters": [
{
"in": "path",
"name": "networkId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Network references"
}
}
},
"description": "OK"
}
},
"summary": "Get Network References",
"tags": [
"Networks"
]
}
},
"/v1/sites/{siteId}/radius/profiles": {
"get": {
"description": "Returns available RADIUS authentication profiles, including configuration origin metadata.\n\n\nFilterable properties (click to expand)
\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 ",
"operationId": "getRadiusProfileOverviewPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Radius Profile Overview Page"
}
}
},
"description": "OK"
}
},
"summary": "List Radius Profiles",
"tags": [
"Supporting Resources"
]
}
},
"/v1/sites/{siteId}/switching/lags": {
"get": {
"description": "Retrieve a paginated list of all LAGs (Link Aggregation Groups) on a site.\n\n\nFilterable properties (click to expand)
\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`switchStackId`|`UUID`|`eq` `ne` `in` `notIn` `isNull` `isNotNull`|\n|`mcLagDomainId`|`UUID`|`eq` `ne` `in` `notIn` `isNull` `isNotNull`|\n|`members.deviceId`|`SET(UUID)`|`contains` `containsAny` `containsAll` `containsExactly`|\n|`members.portIdxs`|`SET(INTEGER)`|`contains` `containsAny` `containsAll` `containsExactly`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n ",
"operationId": "getLagPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationLagPageDto"
}
}
},
"description": "OK"
}
},
"summary": "List LAGs",
"tags": [
"Switching"
]
}
},
"/v1/sites/{siteId}/switching/lags/{lagId}": {
"get": {
"description": "Retrieve LAG details.",
"operationId": "getLag",
"parameters": [
{
"in": "path",
"name": "lagId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LAG details"
}
}
},
"description": "OK"
}
},
"summary": "Get LAG Details",
"tags": [
"Switching"
]
}
},
"/v1/sites/{siteId}/switching/mc-lag-domains": {
"get": {
"description": "Retrieve a paginated list of all MC-LAG Domains on a site.\n\n\nFilterable properties (click to expand)
\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`peers.deviceId`|`SET(UUID)`|`contains` `containsAny` `containsAll` `containsExactly`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n ",
"operationId": "getMcLagDomainPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationMcLagDomainDtoPageDto"
}
}
},
"description": "OK"
}
},
"summary": "List MC-LAG Domains",
"tags": [
"Switching"
]
}
},
"/v1/sites/{siteId}/switching/mc-lag-domains/{mcLagDomainId}": {
"get": {
"description": "Retrieve MC-LAG Domain details.",
"operationId": "getMcLagDomain",
"parameters": [
{
"in": "path",
"name": "mcLagDomainId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationMcLagDomainDto"
}
}
},
"description": "OK"
}
},
"summary": "Get MC-LAG Domain",
"tags": [
"Switching"
]
}
},
"/v1/sites/{siteId}/switching/switch-stacks": {
"get": {
"description": "Retrieve a paginated list of all Switch Stacks on a site.\n\n\nFilterable properties (click to expand)
\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`members.deviceId`|`SET(UUID)`|`contains` `containsAny` `containsAll` `containsExactly`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n ",
"operationId": "getSwitchStackPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationSwitchStackDtoPageDto"
}
}
},
"description": "OK"
}
},
"summary": "List Switch Stacks",
"tags": [
"Switching"
]
}
},
"/v1/sites/{siteId}/switching/switch-stacks/{switchStackId}": {
"get": {
"description": "Retrieve Switch Stack details.",
"operationId": "getSwitchStack",
"parameters": [
{
"in": "path",
"name": "switchStackId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationSwitchStackDto"
}
}
},
"description": "OK"
}
},
"summary": "Get Switch Stack",
"tags": [
"Switching"
]
}
},
"/v1/sites/{siteId}/traffic-matching-lists": {
"get": {
"description": "Retrieve all traffic matching lists on a site.\n\n\nFilterable properties (click to expand)
\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n ",
"operationId": "getTrafficMatchingLists",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Traffic matching lists page"
}
}
},
"description": "OK"
}
},
"summary": "List Traffic Matching Lists",
"tags": [
"Traffic Matching Lists"
]
},
"post": {
"description": "Create a new traffic matching list on a site.",
"operationId": "createTrafficMatchingList",
"parameters": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update traffic matching list"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Traffic matching list"
}
}
},
"description": "Created"
}
},
"summary": "Create Traffic Matching List",
"tags": [
"Traffic Matching Lists"
]
}
},
"/v1/sites/{siteId}/traffic-matching-lists/{trafficMatchingListId}": {
"delete": {
"description": "Delete an exist traffic matching list on a site.",
"operationId": "deleteTrafficMatchingList",
"parameters": [
{
"in": "path",
"name": "trafficMatchingListId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Delete Traffic Matching List",
"tags": [
"Traffic Matching Lists"
]
},
"get": {
"description": "Get an exist traffic matching list on a site.",
"operationId": "getTrafficMatchingList",
"parameters": [
{
"in": "path",
"name": "trafficMatchingListId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Traffic matching list"
}
}
},
"description": "OK"
}
},
"summary": "Get Traffic Matching List",
"tags": [
"Traffic Matching Lists"
]
},
"put": {
"description": "Update an exist traffic matching list on a site.",
"operationId": "updateTrafficMatchingList",
"parameters": [
{
"in": "path",
"name": "trafficMatchingListId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update traffic matching list"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Traffic matching list"
}
}
},
"description": "OK"
}
},
"summary": "Update Traffic Matching List",
"tags": [
"Traffic Matching Lists"
]
}
},
"/v1/sites/{siteId}/vpn/servers": {
"get": {
"description": "Retrieve a paginated list of all VPN servers on a site.\n\n\nFilterable properties (click to expand)
\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 ",
"operationId": "getVpnServerPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationVpnServerOverviewPageDto"
}
}
},
"description": "OK"
}
},
"summary": "List VPN Servers",
"tags": [
"Supporting Resources"
]
}
},
"/v1/sites/{siteId}/vpn/site-to-site-tunnels": {
"get": {
"description": "Retrieve a paginated list of all site-to-site VPN tunnels on a site.\n\n\nFilterable properties (click to expand)
\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 ",
"operationId": "getSiteToSiteVpnTunnelPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationSiteToSiteVpnTunnelOverviewPageDto"
}
}
},
"description": "OK"
}
},
"summary": "List Site-To-Site VPN Tunnels",
"tags": [
"Supporting Resources"
]
}
},
"/v1/sites/{siteId}/wans": {
"get": {
"description": "Returns available WAN interface definitions for a given site,\nincluding identifiers and names. Useful for network and NAT configuration.",
"operationId": "getWansOverviewPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WAN overview page"
}
}
},
"description": "OK"
}
},
"summary": "List WAN Interfaces",
"tags": [
"Supporting Resources"
]
}
},
"/v1/sites/{siteId}/wifi/broadcasts": {
"get": {
"description": "Retrieve a paginated list of all Wifi Broadcasts on a site.\n\n\nFilterable properties (click to expand)
\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`enabled`|`BOOLEAN`|`eq` `ne`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`broadcastingFrequenciesGHz`|`SET(DECIMAL)`|`contains` `containsAny` `containsAll` `containsExactly`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n|`network.type`|`STRING`|`eq` `ne` `in` `notIn` `isNull` `isNotNull`|\n|`network.networkId`|`UUID`|`eq` `ne` `in` `notIn`|\n|`securityConfiguration.type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`broadcastingDeviceFilter.type`|`STRING`|`eq` `ne` `in` `notIn` `isNull` `isNotNull`|\n|`broadcastingDeviceFilter.deviceIds`|`SET(UUID)`|`contains` `containsAny` `containsAll` `containsExactly`|\n|`broadcastingDeviceFilter.deviceTagIds`|`SET(UUID)`|`contains` `containsAny` `containsAll` `containsExactly`|\n|`hotspotConfiguration.type`|`STRING`|`eq` `ne` `in` `notIn`|\n ",
"operationId": "getWifiBroadcastPage",
"parameters": [
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 200,
"minimum": 0,
"type": "integer"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationWifiBroadcastPageDto"
}
}
},
"description": "OK"
}
},
"summary": "List Wifi Broadcasts",
"tags": [
"WiFi Broadcasts"
]
},
"post": {
"description": "Create a new Wifi Broadcast on the specified site.",
"operationId": "createWifiBroadcast",
"parameters": [
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wifi broadcast create or update"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wifi broadcast details"
}
}
},
"description": "Created"
}
},
"summary": "Create Wifi Broadcast",
"tags": [
"WiFi Broadcasts"
]
}
},
"/v1/sites/{siteId}/wifi/broadcasts/{wifiBroadcastId}": {
"delete": {
"description": "Delete an existing Wifi Broadcast from the specified site.",
"operationId": "deleteWifiBroadcast",
"parameters": [
{
"in": "path",
"name": "wifiBroadcastId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "force",
"required": false,
"schema": {
"default": false,
"type": "boolean"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"summary": "Delete Wifi Broadcast",
"tags": [
"WiFi Broadcasts"
]
},
"get": {
"description": "Retrieve detailed information about a specific Wifi.",
"operationId": "getWifiBroadcastDetails",
"parameters": [
{
"in": "path",
"name": "wifiBroadcastId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wifi broadcast details"
}
}
},
"description": "OK"
}
},
"summary": "Get Wifi Broadcast Details",
"tags": [
"WiFi Broadcasts"
]
},
"put": {
"description": "Update an existing Wifi Broadcast on the specified site.",
"operationId": "updateWifiBroadcast",
"parameters": [
{
"in": "path",
"name": "wifiBroadcastId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "siteId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wifi broadcast create or update"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wifi broadcast details"
}
}
},
"description": "OK"
}
},
"summary": "Update Wifi Broadcast",
"tags": [
"WiFi Broadcasts"
]
}
}
},
"servers": [
{
"url": "https://api.ui.com/v1/connector/consoles/{consoleId}/proxy/network/integration",
"description": "UniFi API Cloud Connector",
"variables": {
"consoleId": {
"default": "942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999",
"description": "ID of the console to proxy requests to"
}
}
},
{
"url": "https://{consoleIP}/proxy/network/integration",
"description": "Local Console",
"variables": {
"consoleIP": {
"default": "192.168.0.1",
"description": "IP address of the console on the local network"
}
}
}
],
"tags": [
{
"description": "Returns general details about the UniFi Network application,\nincluding version and runtime metadata. Useful for integration validation.",
"name": "Application Info"
},
{
"description": "Endpoints for listing and managing UniFi sites within a local Network application.\nSite ID is required for most other API requests.",
"name": "Sites"
},
{
"description": "Endpoints to list, inspect, and interact with UniFi devices, including adopted and pending devices.\nProvides device stats, port control, and actions.",
"name": "UniFi Devices"
},
{
"description": "Endpoints for viewing and managing connected clients (wired, wireless, VPN, and guest).\nSupports actions such as authorizing or unauthorizing guest access.",
"name": "Clients"
},
{
"description": "Endpoints for creating, updating, deleting, and inspecting network configurations\nincluding VLANs, DHCP, NAT, and IPv4/IPv6 settings.",
"name": "Networks"
},
{
"description": "Endpoints to create, update, or remove WiFi networks (SSIDs).\nSupports configuration of security, band steering, multicast filtering, and captive portals.",
"name": "WiFi Broadcasts"
},
{
"description": "Endpoints for managing guest access via Hotspot vouchers — create, list, or revoke vouchers\nand track their usage and expiration.",
"name": "Hotspot"
},
{
"description": "Endpoints for managing custom firewall zones and policies within a site.\nDefine or update network segmentation and security boundaries.",
"name": "Firewall"
},
{
"description": "Endpoints for creating, listing, and managing ACL (Access Control List) rule\nthat enforce traffic filtering across devices and networks.",
"name": "Access Control (ACL Rules)"
},
{
"description": "Endpoints for managing switching features like Switch Stacking and LAG.",
"name": "Switching"
},
{
"description": "Endpoints for managing DNS Policies within a site.",
"name": "DNS Policies"
},
{
"description": "Endpoints for managing port and IP address lists used across firewall policy configurations.",
"name": "Traffic Matching Lists"
},
{
"description": "Contains read-only reference endpoints used to retrieve supporting data\nsuch as WAN interfaces, DPI categories, country codes, RADIUS profiles, and device tags.",
"name": "Supporting Resources"
}
]
}