{
"openapi": "3.0.3",
"info": {
"title": "UniFi Network API",
"description": "",
"license": {
"name": "Proprietary"
},
"version": "10.1.84"
},
"servers": [
{
"url": "/integration"
}
],
"tags": [
{
"name": "Getting Started",
"description": "Provides an overview of the UniFi Network API, including authentication using API keys and request format. \nStart here to understand how to connect and make your first request.\n\n### Introduction\n\nEach UniFi Application has its own API endpoints running locally on each site,\noffering detailed analytics and control related to that specific application.\nFor a single endpoint with high-level insights across all your UniFi sites,\nrefer to the [UniFi Site Manager API](https://developer.ui.com).\n\n### Authentication and Request Format\n\nAn API Key is a unique identifier used to authenticate API requests.\nTo generate API Keys and view an example of the API Request Format,\nvisit the Integrations section of your UniFi application."
},
{
"name": "Filtering",
"description": "Explains how to use the filter query parameter for advanced querying across list endpoints,\nincluding supported property types, syntax, and operators.\n\nSome `GET` and `DELETE` endpoints support filtering using the `filter` query parameter.\nEach endpoint supporting filtering will have a detailed list of filterable properties, their types, and allowed functions.\n\n### Filtering Syntax\n\nFiltering follows a structured, URL-safe syntax with three types of expressions.\n\n#### 1. Property Expressions\n\nApply functions to an individual property using the form `<property>.<function>(<arguments>)`,\nwhere argument values are separated by commas.\n\nExamples:\n\n- `id.eq(123)` checks if `id` is equal to `123`;\n- `name.isNotNull()` checks if `name` is not null;\n- `createdAt.in(2025-01-01, 2025-01-05)` checks if `createdAt` is either `2025-01-01` or `2025-01-05`.\n\n#### 2. Compound Expressions\n\nCombine two or more expressions with logical operators using the form `<logical-operator>(<expressions>)`,\nwhere expressions are separated by commas.\n\nExamples:\n\n- `and(name.isNull(), createdAt.gt(2025-01-01))` checks if `name` is null **and** `createdAt` is greater than `2025-01-01`;\n- `or(name.isNull(), expired.isNull(), expiresAt.isNull())` check is **any** of `name`, `expired`, or `expiresAt` is null.\n\n#### 3. Negation Expressions\n\nNegate any other expressions using the the form `not(<expression>)`.\n\nExample:\n\n- `not(name.like('guest*'))` matches all values except those that start with `guest`.\n\n### Filterable Property Types\n\nThe table below lists all supported property types.\n\n|Type|Examples|Syntax|\n|-|-|-|\n|`STRING`|`'Hello, ''World''!'`|Must be wrapped in single quotes. To escape a single quote, use another single quote.|\n|`INTEGER`|`123`|Must start with a digit.|\n|`DECIMAL`|`123`, `123.321`|Must start with a digit. Can include a decimal point (.).|\n|`TIMESTAMP`|`2025-01-29`, `2025-01-29T12:39:11Z`|Must follow ISO 8601 format (date or date-time).|\n|`BOOLEAN`|`true`, `false`|Can be `true` or `false`.|\n|`UUID`|`550e8400-e29b-41d4-a716-446655440000`|Must be a valid UUID format (8-4-4-4-12).|\n|`SET(STRING\\|INTEGER\\|DECIMAL\\|TIMESTAMP\\|UUID)`|`[1, 2, 3, 4, 5]`|A set of (unique) values.|\n\n### Filtering Functions\n\nThe table below lists available filtering functions, their arguments, and applicable property types:\n\n|Function|Arguments|Semantics|Supported property types|\n|-|-|-|-|\n|`isNull`|0|is null|all types|\n|`isNotNull`|0|is not null|all types|\n|`eq`|1|equals|`STRING`, `INTEGER`, `DECIMAL`, `TIMESTAMP`, `BOOLEAN`, `UUID`|\n|`ne`|1|not equals|`STRING`, `INTEGER`, `DECIMAL`, `TIMESTAMP`, `BOOLEAN`, `UUID`|\n|`gt`|1|greater than|`STRING`, `INTEGER`, `DECIMAL`, `TIMESTAMP`, `UUID`|\n|`ge`|1|greater than or equals|`STRING`, `INTEGER`, `DECIMAL`, `TIMESTAMP`, `UUID`|\n|`lt`|1|less than|`STRING`, `INTEGER`, `DECIMAL`, `TIMESTAMP`, `UUID`|\n|`le`|1|less than or equals|`STRING`, `INTEGER`, `DECIMAL`, `TIMESTAMP`, `UUID`|\n|`like`|1|matches pattern|`STRING`|\n|`in`|1 or more|one of|`STRING`, `INTEGER`, `DECIMAL`, `TIMESTAMP`, `UUID`|\n|`notIn`|1 or more|not one of|`STRING`, `INTEGER`, `DECIMAL`, `TIMESTAMP`, `UUID`|\n|`isEmpty`|0|is empty|`SET`|\n|`contains`|1|contains|`SET`|\n|`containsAny`|1 or more|contains any of|`SET`|\n|`containsAll`|1 or more|contains all of|`SET`|\n|`containsExactly`|1 or more|contains exactly|`SET`|\n\n#### Pattern Matching (`like` Function)\n\nThe `like` function allows matching string properties using simple patterns:\n\n- `.` matches any **single** character. Example: `type.like('type.')` matches `type1`, but not `type100`;\n- `*` matches **any number** of characters. Example: `name.like('guest*')` matches `guest1` and `guest100`;\n- `\\` is used to escape `.` and `*`."
},
{
"name": "Error Handling",
"description": "Describes the standard API error response structure, including error codes,\nstatus names, and troubleshooting guidance."
},
{
"name": "Application Info",
"description": "Returns general details about the UniFi Network application,\nincluding version and runtime metadata. Useful for integration validation."
},
{
"name": "Sites",
"description": "Endpoints for listing and managing UniFi sites within a local Network application.\nSite ID is required for most other API requests."
},
{
"name": "UniFi Devices",
"description": "Endpoints to list, inspect, and interact with UniFi devices, including adopted and pending devices.\nProvides device stats, port control, and actions."
},
{
"name": "Clients",
"description": "Endpoints for viewing and managing connected clients (wired, wireless, VPN, and guest).\nSupports actions such as authorizing or unauthorizing guest access."
},
{
"name": "Networks",
"description": "Endpoints for creating, updating, deleting, and inspecting network configurations\nincluding VLANs, DHCP, NAT, and IPv4/IPv6 settings."
},
{
"name": "WiFi Broadcasts",
"description": "Endpoints to create, update, or remove WiFi networks (SSIDs).\nSupports configuration of security, band steering, multicast filtering, and captive portals."
},
{
"name": "Hotspot",
"description": "Endpoints for managing guest access via Hotspot vouchers \u2014 create, list, or revoke vouchers\nand track their usage and expiration."
},
{
"name": "Firewall",
"description": "Endpoints for managing custom firewall zones and policies within a site.\nDefine or update network segmentation and security boundaries."
},
{
"name": "Access Control (ACL Rules)",
"description": "Endpoints for creating, listing, and managing ACL (Access Control List) rule\nthat enforce traffic filtering across devices and networks."
},
{
"name": "DNS Policies",
"description": "Endpoints for managing DNS Policies within a site."
},
{
"name": "Traffic Matching Lists",
"description": "Endpoints for managing port and IP address lists used across firewall policy configurations."
},
{
"name": "Supporting Resources",
"description": "Contains read-only reference endpoints used to retrieve supporting data\nsuch as WAN interfaces, DPI categories, country codes, RADIUS profiles, and device tags."
}
],
"paths": {
"/v1/sites/{siteId}/wifi/broadcasts/{wifiBroadcastId}": {
"get": {
"tags": [
"WiFi Broadcasts"
],
"summary": "Get Wifi Broadcast Details",
"description": "Retrieve detailed information about a specific Wifi.",
"operationId": "getWifiBroadcastDetails",
"parameters": [
{
"name": "wifiBroadcastId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wifi broadcast details"
}
}
}
}
}
},
"put": {
"tags": [
"WiFi Broadcasts"
],
"summary": "Update Wifi Broadcast",
"description": "Update an existing Wifi Broadcast on the specified site.",
"operationId": "updateWifiBroadcast",
"parameters": [
{
"name": "wifiBroadcastId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wifi broadcast create or update"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wifi broadcast details"
}
}
}
}
}
},
"delete": {
"tags": [
"WiFi Broadcasts"
],
"summary": "Delete Wifi Broadcast",
"description": "Delete an existing Wifi Broadcast from the specified site.",
"operationId": "deleteWifiBroadcast",
"parameters": [
{
"name": "wifiBroadcastId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "force",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v1/sites/{siteId}/traffic-matching-lists/{trafficMatchingListId}": {
"get": {
"tags": [
"Traffic Matching Lists"
],
"summary": "Get Traffic Matching List",
"description": "Get an exist traffic matching list on a site.",
"operationId": "getTrafficMatchingList",
"parameters": [
{
"name": "trafficMatchingListId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Traffic matching list"
}
}
}
}
}
},
"put": {
"tags": [
"Traffic Matching Lists"
],
"summary": "Update Traffic Matching List",
"description": "Update an exist traffic matching list on a site.",
"operationId": "updateTrafficMatchingList",
"parameters": [
{
"name": "trafficMatchingListId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update traffic matching list"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Traffic matching list"
}
}
}
}
}
},
"delete": {
"tags": [
"Traffic Matching Lists"
],
"summary": "Delete Traffic Matching List",
"description": "Delete an exist traffic matching list on a site.",
"operationId": "deleteTrafficMatchingList",
"parameters": [
{
"name": "trafficMatchingListId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v1/sites/{siteId}/networks/{networkId}": {
"get": {
"tags": [
"Networks"
],
"summary": "Get Network Details",
"description": "Retrieve detailed information about a specific network.",
"operationId": "getNetworkDetails",
"parameters": [
{
"name": "networkId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Network details"
}
}
}
}
}
},
"put": {
"tags": [
"Networks"
],
"summary": "Update Network",
"description": "Update an existing network on a site.",
"operationId": "updateNetwork",
"parameters": [
{
"name": "networkId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update Network"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Network details"
}
}
}
}
}
},
"delete": {
"tags": [
"Networks"
],
"summary": "Delete Network",
"description": "Delete an existing network on a site.",
"operationId": "deleteNetwork",
"parameters": [
{
"name": "networkId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "force",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v1/sites/{siteId}/firewall/zones/{firewallZoneId}": {
"get": {
"tags": [
"Firewall"
],
"summary": "Get Firewall Zone",
"description": "Get a firewall zone on a site.",
"operationId": "getFirewallZone",
"parameters": [
{
"name": "firewallZoneId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall zone"
}
}
}
}
}
},
"put": {
"tags": [
"Firewall"
],
"summary": "Update Firewall Zone",
"description": "Update a firewall zone on a site.",
"operationId": "updateFirewallZone",
"parameters": [
{
"name": "firewallZoneId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update firewall zone"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall zone"
}
}
}
}
}
},
"delete": {
"tags": [
"Firewall"
],
"summary": "Delete Custom Firewall Zone",
"description": "Delete a custom firewall zone from a site.",
"operationId": "deleteFirewallZone",
"parameters": [
{
"name": "firewallZoneId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v1/sites/{siteId}/firewall/policies/{firewallPolicyId}": {
"get": {
"tags": [
"Firewall"
],
"summary": "Get Firewall Policy",
"description": "Retrieve specific firewall policy.",
"operationId": "getFirewallPolicy",
"parameters": [
{
"name": "firewallPolicyId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall policy"
}
}
}
}
}
},
"put": {
"tags": [
"Firewall"
],
"summary": "Update Firewall Policy",
"description": "Update an existing firewall policy on a site.",
"operationId": "updateFirewallPolicy",
"parameters": [
{
"name": "firewallPolicyId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update firewall policy"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall policy"
}
}
}
}
}
},
"delete": {
"tags": [
"Firewall"
],
"summary": "Delete Firewall Policy",
"description": "Delete an existing firewall policy on a site.",
"operationId": "deleteFirewallPolicy",
"parameters": [
{
"name": "firewallPolicyId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"patch": {
"tags": [
"Firewall"
],
"summary": "Patch Firewall Policy",
"description": "Patch an existing firewall policy on a site.",
"operationId": "patchFirewallPolicy",
"parameters": [
{
"name": "firewallPolicyId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Patch firewall policy"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall policy"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/firewall/policies/ordering": {
"get": {
"tags": [
"Firewall"
],
"summary": "Get User-Defined Firewall Policy Ordering",
"description": "Retrieve user-defined firewall policy ordering for a specific source/destination zone pair.",
"operationId": "getFirewallPolicyOrdering",
"parameters": [
{
"name": "sourceFirewallZoneId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "destinationFirewallZoneId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationFirewallPolicyOrderingDto"
}
}
}
}
}
},
"put": {
"tags": [
"Firewall"
],
"summary": "Reorder User-Defined Firewall Policies",
"description": "Reorder user-defined firewall policies for a specific source/destination zone pair.",
"operationId": "updateFirewallPolicyOrdering",
"parameters": [
{
"name": "sourceFirewallZoneId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "destinationFirewallZoneId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationFirewallPolicyOrderingDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationFirewallPolicyOrderingDto"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/dns/policies/{dnsPolicyId}": {
"get": {
"tags": [
"DNS Policies"
],
"summary": "Get DNS Policy",
"description": "Retrieve specific DNS policy.",
"operationId": "getDnsPolicy",
"parameters": [
{
"name": "dnsPolicyId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DNS policy"
}
}
}
}
}
},
"put": {
"tags": [
"DNS Policies"
],
"summary": "Update DNS Policy",
"description": "Update an existing DNS policy on a site.",
"operationId": "updateDnsPolicy",
"parameters": [
{
"name": "dnsPolicyId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update DNS policy"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DNS policy"
}
}
}
}
}
},
"delete": {
"tags": [
"DNS Policies"
],
"summary": "Delete DNS Policy",
"description": "Delete an existing DNS policy on a site.",
"operationId": "deleteDnsPolicy",
"parameters": [
{
"name": "dnsPolicyId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v1/sites/{siteId}/acl-rules/{aclRuleId}": {
"get": {
"tags": [
"Access Control (ACL Rules)"
],
"summary": "Get ACL Rule",
"operationId": "getAclRule",
"parameters": [
{
"name": "aclRuleId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule"
}
}
}
}
}
},
"put": {
"tags": [
"Access Control (ACL Rules)"
],
"summary": "Update ACL Rule",
"description": "Update an existing user defined ACL rule on a site.",
"operationId": "updateAclRule",
"parameters": [
{
"name": "aclRuleId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule update"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule"
}
}
}
}
}
},
"delete": {
"tags": [
"Access Control (ACL Rules)"
],
"summary": "Delete ACL Rule",
"description": "Delete an existing user defined ACL rule on a site.",
"operationId": "deleteAclRule",
"parameters": [
{
"name": "aclRuleId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v1/sites/{siteId}/acl-rules/ordering": {
"get": {
"tags": [
"Access Control (ACL Rules)"
],
"summary": "Get User-Defined ACL Rule Ordering",
"description": "Retrieve user-defined ACL rule ordering on a site.",
"operationId": "getAclRuleOrdering",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule ordering"
}
}
}
}
}
},
"put": {
"tags": [
"Access Control (ACL Rules)"
],
"summary": "Reorder User-Defined ACL Rules",
"description": "Reorder user-defined ACL rules on a site.",
"operationId": "updateAclRuleOrdering",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule ordering"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule ordering"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/wifi/broadcasts": {
"get": {
"tags": [
"WiFi Broadcasts"
],
"summary": "List Wifi Broadcasts",
"description": "Retrieve a paginated list of all Wifi Broadcasts on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`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</details>",
"operationId": "getWifiBroadcastPage",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationWifiBroadcastPageDto"
}
}
}
}
}
},
"post": {
"tags": [
"WiFi Broadcasts"
],
"summary": "Create Wifi Broadcast",
"description": "Create a new Wifi Broadcast on the specified site.",
"operationId": "createWifiBroadcast",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wifi broadcast create or update"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wifi broadcast details"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/traffic-matching-lists": {
"get": {
"tags": [
"Traffic Matching Lists"
],
"summary": "List Traffic Matching Lists",
"description": "Retrieve all traffic matching lists on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n</details>",
"operationId": "getTrafficMatchingLists",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Traffic matching lists page"
}
}
}
}
}
},
"post": {
"tags": [
"Traffic Matching Lists"
],
"summary": "Create Traffic Matching List",
"description": "Create a new traffic matching list on a site.",
"operationId": "createTrafficMatchingList",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update traffic matching list"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Traffic matching list"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/networks": {
"get": {
"tags": [
"Networks"
],
"summary": "List Networks",
"description": "Retrieve a paginated list of all Networks on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`management`|`STRING`|`eq` `ne` `in` `notIn`|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`enabled`|`BOOLEAN`|`eq` `ne`|\n|`vlanId`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le` `in` `notIn`|\n|`deviceId`|`UUID`|`eq` `ne` `in` `notIn` `isNull` `isNotNull`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n</details>",
"operationId": "getNetworksOverviewPage",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Network overview page"
}
}
}
}
}
},
"post": {
"tags": [
"Networks"
],
"summary": "Create Network",
"description": "Create a new network on a site.",
"operationId": "createNetwork",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update Network"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Network details"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/hotspot/vouchers": {
"get": {
"tags": [
"Hotspot"
],
"summary": "List Vouchers",
"description": "Retrieve a paginated list of Hotspot vouchers.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`createdAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`code`|`STRING`|`eq` `ne` `in` `notIn`|\n|`authorizedGuestLimit`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`authorizedGuestCount`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`activatedAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`expiresAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`expired`|`BOOLEAN`|`eq` `ne`|\n|`timeLimitMinutes`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`dataUsageLimitMBytes`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`rxRateLimitKbps`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`txRateLimitKbps`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n</details>",
"operationId": "getVouchers",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 100,
"maximum": 1000,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Hotspot voucher detail page"
}
}
}
}
}
},
"post": {
"tags": [
"Hotspot"
],
"summary": "Generate Vouchers",
"description": "Create one or more Hotspot vouchers.",
"operationId": "createVouchers",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Hotspot voucher creation request"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationVoucherCreationResultDto"
}
}
}
}
}
},
"delete": {
"tags": [
"Hotspot"
],
"summary": "Delete Vouchers",
"description": "Remove Hotspot vouchers based on the specified filter criteria.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`createdAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`code`|`STRING`|`eq` `ne` `in` `notIn`|\n|`authorizedGuestLimit`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`authorizedGuestCount`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`activatedAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`expiresAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`expired`|`BOOLEAN`|`eq` `ne`|\n|`timeLimitMinutes`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`dataUsageLimitMBytes`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`rxRateLimitKbps`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`txRateLimitKbps`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n</details>",
"operationId": "deleteVouchers",
"parameters": [
{
"name": "filter",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Voucher deletion results"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/firewall/zones": {
"get": {
"tags": [
"Firewall"
],
"summary": "List Firewall Zones",
"description": "Retrieve a list of all firewall zones on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n|`metadata.configurable`|`BOOLEAN`|`eq` `ne` `isNull` `isNotNull`|\n</details>",
"operationId": "getFirewallZones",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall zones page"
}
}
}
}
}
},
"post": {
"tags": [
"Firewall"
],
"summary": "Create Custom Firewall Zone",
"description": "Create a new custom firewall zone on a site.",
"operationId": "createFirewallZone",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update firewall zone"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall zone"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/firewall/policies": {
"get": {
"tags": [
"Firewall"
],
"summary": "List Firewall Policies",
"description": "Retrieve a list of all firewall policies on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`source.zoneId`|`UUID`|`eq` `ne` `in` `notIn`|\n|`destination.zoneId`|`UUID`|`eq` `ne` `in` `notIn`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n</details>",
"operationId": "getFirewallPolicies",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall policy page"
}
}
}
}
}
},
"post": {
"tags": [
"Firewall"
],
"summary": "Create Firewall Policy",
"description": "Create a new firewall policy on a site.",
"operationId": "createFirewallPolicy",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update firewall policy"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Firewall policy"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/dns/policies": {
"get": {
"tags": [
"DNS Policies"
],
"summary": "List DNS Policies",
"description": "Retrieve a paginated list of all DNS policies on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`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</details>",
"operationId": "getDnsPolicyPage",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationDnsPolicyPageDto"
}
}
}
}
}
},
"post": {
"tags": [
"DNS Policies"
],
"summary": "Create DNS Policy",
"description": "Create a new DNS policy on a site.",
"operationId": "createDnsPolicy",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create or update DNS policy"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DNS policy"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/devices": {
"get": {
"tags": [
"UniFi Devices"
],
"summary": "List Adopted Devices",
"description": "Retrieve a paginated list of all adopted devices on a site, including basic device information.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`macAddress`|`STRING`|`eq` `ne` `in` `notIn`|\n|`ipAddress`|`STRING`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`model`|`STRING`|`eq` `ne` `in` `notIn`|\n|`state`|`STRING`|`eq` `ne` `in` `notIn`|\n|`supported`|`BOOLEAN`|`eq` `ne`|\n|`firmwareVersion`|`STRING`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le` `like` `in` `notIn`|\n|`firmwareUpdatable`|`BOOLEAN`|`eq` `ne`|\n|`features`|`SET(STRING)`|`isEmpty` `contains` `containsAny` `containsAll` `containsExactly`|\n|`interfaces`|`SET(STRING)`|`isEmpty` `contains` `containsAny` `containsAll` `containsExactly`|\n</details>",
"operationId": "getAdoptedDeviceOverviewPage",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Adopted device overview page"
}
}
}
}
}
},
"post": {
"tags": [
"UniFi Devices"
],
"summary": "Adopt Devices",
"description": "Adopt a device to a site.",
"operationId": "adoptDevice",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationDeviceAdoptionRequestDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Adopted device details"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/devices/{deviceId}/interfaces/ports/{portIdx}/actions": {
"post": {
"tags": [
"UniFi Devices"
],
"summary": "Execute Port Action",
"description": "Perform an action on a specific device port. The request body must include the action name and any applicable input arguments.",
"operationId": "executePortAction",
"parameters": [
{
"name": "portIdx",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "deviceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Port action request"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v1/sites/{siteId}/devices/{deviceId}/actions": {
"post": {
"tags": [
"UniFi Devices"
],
"summary": "Execute Adopted Device Action",
"description": "Perform an action on an specific adopted device. The request body must include the action name and any applicable input arguments.",
"operationId": "executeAdoptedDeviceAction",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "deviceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Device action request"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v1/sites/{siteId}/clients/{clientId}/actions": {
"post": {
"tags": [
"Clients"
],
"summary": "Execute Client Action",
"description": "Perform an action on a specific connected client. The request body must include the action name and any applicable input arguments.",
"operationId": "executeConnectedClientAction",
"parameters": [
{
"name": "clientId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client action request"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client action response"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/acl-rules": {
"get": {
"tags": [
"Access Control (ACL Rules)"
],
"summary": "List ACL Rules",
"description": "Retrieve a paginated list of all ACL rules on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`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</details>",
"operationId": "getAclRulePage",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationAclRulePageDto"
}
}
}
}
}
},
"post": {
"tags": [
"Access Control (ACL Rules)"
],
"summary": "Create ACL Rule",
"description": "Create a new user defined ACL rule on a site.",
"operationId": "createAclRule",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule update"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ACL rule"
}
}
}
}
}
}
},
"/v1/sites": {
"get": {
"tags": [
"Sites"
],
"summary": "List Local Sites",
"description": "Retrieve a paginated list of local sites managed by this Network application.\nSite ID is required for other UniFi Network API calls.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`internalReference`|`STRING`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn`|\n</details>",
"operationId": "getSiteOverviewPage",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site overview page"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/wans": {
"get": {
"tags": [
"Supporting Resources"
],
"summary": "List WAN Interfaces",
"description": "Returns available WAN interface definitions for a given site,\nincluding identifiers and names. Useful for network and NAT configuration.",
"operationId": "getWansOverviewPage",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WAN overview page"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/vpn/site-to-site-tunnels": {
"get": {
"tags": [
"Supporting Resources"
],
"summary": "List Site-To-Site VPN Tunnels",
"description": "Retrieve a paginated list of all site-to-site VPN tunnels on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n|`metadata.source`|`STRING`|`eq` `ne` `in` `notIn` `isNull` `isNotNull`|\n</details>",
"operationId": "getSiteToSiteVpnTunnelPage",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationSiteToSiteVpnTunnelOverviewPageDto"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/vpn/servers": {
"get": {
"tags": [
"Supporting Resources"
],
"summary": "List VPN Servers",
"description": "Retrieve a paginated list of all VPN servers on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`enabled`|`BOOLEAN`|`eq` `ne`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n</details>",
"operationId": "getVpnServerPage",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationVpnServerOverviewPageDto"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/radius/profiles": {
"get": {
"tags": [
"Supporting Resources"
],
"summary": "List Radius Profiles",
"description": "Returns available RADIUS authentication profiles, including configuration origin metadata.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n</details>",
"operationId": "getRadiusProfileOverviewPage",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Radius Profile Overview Page"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/networks/{networkId}/references": {
"get": {
"tags": [
"Networks"
],
"summary": "Get Network References",
"description": "Retrieve references to a specific network.",
"operationId": "getNetworkReferences",
"parameters": [
{
"name": "networkId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Network references"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/hotspot/vouchers/{voucherId}": {
"get": {
"tags": [
"Hotspot"
],
"summary": "Get Voucher Details",
"description": "Retrieve details of a specific Hotspot voucher.",
"operationId": "getVoucher",
"parameters": [
{
"name": "voucherId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Hotspot voucher details"
}
}
}
}
}
},
"delete": {
"tags": [
"Hotspot"
],
"summary": "Delete Voucher",
"description": "Remove a specific Hotspot voucher.",
"operationId": "deleteVoucher",
"parameters": [
{
"name": "voucherId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Voucher deletion results"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/devices/{deviceId}": {
"get": {
"tags": [
"UniFi Devices"
],
"summary": "Get Adopted Device Details",
"description": "Retrieve detailed information about a specific adopted device, including firmware versioning, uplink state, details about device features and interfaces (ports, radios) and other key attributes.",
"operationId": "getAdoptedDeviceDetails",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "deviceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Adopted device details"
}
}
}
}
}
},
"delete": {
"tags": [
"UniFi Devices"
],
"summary": "Remove (Unadopt) Device",
"description": "Removes (unadopts) an adopted device from the site. If the device is online, it will be reset to factory defaults.",
"operationId": "removeDevice",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "deviceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v1/sites/{siteId}/devices/{deviceId}/statistics/latest": {
"get": {
"tags": [
"UniFi Devices"
],
"summary": "Get Latest Adopted Device Statistics",
"description": "Retrieve the latest real-time statistics of a specific adopted device, such as uptime, data transmission rates, CPU and memory utilization.",
"operationId": "getAdoptedDeviceLatestStatistics",
"parameters": [
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "deviceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Latest statistics for a device"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/device-tags": {
"get": {
"tags": [
"Supporting Resources"
],
"summary": "List Device Tags",
"description": "Returns all device tags defined within a site, which can be used for WiFi Broadcast assignments.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`deviceIds`|`SET(UUID)`|`contains` `containsAny` `containsAll` `containsExactly`|\n</details>",
"operationId": "getDeviceTagPage",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/FilterExpression"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationDeviceTagPageDto"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/clients": {
"get": {
"tags": [
"Clients"
],
"summary": "List Connected Clients",
"description": "Retrieve a paginated list of all connected clients on a site, including physical devices (computers, smartphones) and active VPN connections.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`macAddress`|`STRING`|`isNull` `isNotNull` `eq` `ne` `in` `notIn`|\n|`ipAddress`|`STRING`|`isNull` `isNotNull` `eq` `ne` `in` `notIn`|\n|`connectedAt`|`TIMESTAMP`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`access.type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`access.authorized`|`BOOLEAN`|`isNull` `isNotNull` `eq` `ne`|\n</details>",
"operationId": "getConnectedClientOverviewPage",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client overview page"
}
}
}
}
}
}
},
"/v1/sites/{siteId}/clients/{clientId}": {
"get": {
"tags": [
"Clients"
],
"summary": "Get Connected Client Details",
"description": "Retrieve detailed information about a specific connected client, including name, IP address, MAC address, connection type and access information.",
"operationId": "getConnectedClientDetails",
"parameters": [
{
"name": "clientId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "siteId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Client details"
}
}
}
}
}
}
},
"/v1/pending-devices": {
"get": {
"tags": [
"UniFi Devices"
],
"summary": "List Devices Pending Adoption",
"description": "Retrieve a paginated list of devices pending adoption, including basic device information.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`macAddress`|`STRING`|`eq` `ne` `in` `notIn`|\n|`ipAddress`|`STRING`|`eq` `ne` `in` `notIn`|\n|`model`|`STRING`|`eq` `ne` `in` `notIn`|\n|`state`|`STRING`|`eq` `ne` `in` `notIn`|\n|`supported`|`BOOLEAN`|`eq` `ne`|\n|`firmwareVersion`|`STRING`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le` `like` `in` `notIn`|\n|`firmwareUpdatable`|`BOOLEAN`|`eq` `ne`|\n|`features`|`SET(STRING)`|`isEmpty` `contains` `containsAny` `containsAll` `containsExactly`|\n</details>",
"operationId": "getPendingDevicePage",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Device pending adoption page"
}
}
}
}
}
}
},
"/v1/info": {
"get": {
"tags": [
"Application Info"
],
"summary": "Get Application Info",
"description": "Retrieve general information about the UniFi Network application.",
"operationId": "getInfo",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Application info"
}
}
}
}
}
}
},
"/v1/dpi/categories": {
"get": {
"tags": [
"Supporting Resources"
],
"summary": "List DPI Application Categories",
"description": "Returns predefined Deep Packet Inspection (DPI) application categories used for traffic identification and filtering.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`INTEGER`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n</details>",
"operationId": "getDpiApplicationCategories",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DPI category page"
}
}
}
}
}
}
},
"/v1/dpi/applications": {
"get": {
"tags": [
"Supporting Resources"
],
"summary": "List DPI Applications",
"description": "Lists DPI-recognized applications grouped under categories. Useful for firewall or traffic analytics integration.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`INTEGER`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n</details>",
"operationId": "getDpiApplications",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DPI application page"
}
}
}
}
}
}
},
"/v1/countries": {
"get": {
"tags": [
"Supporting Resources"
],
"summary": "List Countries",
"description": "Returns ISO-standard country codes and names,\nused for region-based configuration or regulatory compliance.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`code`|`STRING`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n</details>",
"operationId": "getCountries",
"parameters": [
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 25,
"maximum": 200,
"minimum": 0
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Country definition page"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Error Message": {
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"example": 400
},
"statusName": {
"type": "string",
"example": "UNAUTHORIZED"
},
"code": {
"type": "string",
"example": "api.authentication.missing-credentials"
},
"message": {
"type": "string",
"example": "Missing credentials"
},
"timestamp": {
"type": "string",
"format": "date-time",
"example": "2024-11-27T08:13:46.966Z"
},
"requestPath": {
"type": "string",
"example": "/integration/v1/sites/123"
},
"requestId": {
"type": "string",
"format": "uuid",
"description": "In case of Internal Server Error (core = 500), request ID can be used to track down the error in the server log",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
},
"x-tags": "Error Handling",
"type": "object"
},
"Blackout schedule configuration per day": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"day": {
"type": "string",
"enum": [
"SUN",
"MON",
"TUE",
"WED",
"THU",
"FRI",
"SAT"
]
}
},
"required": [
"day",
"type"
]
},
"Broadcasting device filter": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Integration blackout schedule configuration": {
"type": "object",
"properties": {
"days": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Blackout schedule configuration per day"
},
"minItems": 1
}
},
"required": [
"days"
]
},
"IntegrationIotOptimizedWifiBroadcastCreateUpdateDto": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"network": {
"$ref": "#/components/schemas/Wifi network reference"
},
"enabled": {
"type": "boolean"
},
"securityConfiguration": {
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
"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."
},
"mdnsProxyConfiguration": {
"$ref": "#/components/schemas/mDNS filtering configuration"
},
"multicastFilteringPolicy": {
"$ref": "#/components/schemas/Multicast filtering policy"
},
"multicastToUnicastConversionEnabled": {
"type": "boolean"
},
"clientIsolationEnabled": {
"type": "boolean"
},
"hideName": {
"type": "boolean"
},
"uapsdEnabled": {
"type": "boolean",
"description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"
},
"basicDataRateKbpsByFrequencyGHz": {
"$ref": "#/components/schemas/IntegrationWifiBasicDataRateConfigurationDto"
},
"clientFilteringPolicy": {
"$ref": "#/components/schemas/IntegrationWifiClientFilteringPolicyDto",
"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses."
},
"blackoutScheduleConfiguration": {
"$ref": "#/components/schemas/Integration blackout schedule configuration"
}
},
"required": [
"clientIsolationEnabled",
"enabled",
"hideName",
"multicastToUnicastConversionEnabled",
"name",
"securityConfiguration",
"type",
"uapsdEnabled"
]
},
"IntegrationStandardWifiBroadcastCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi broadcast create or update"
},
{
"type": "object",
"properties": {
"broadcastingFrequenciesGHz": {
"type": "array",
"example": [
2.4,
5
],
"items": {
"type": "number",
"enum": [
2.4,
5.0,
6.0
]
},
"maxItems": 2147483647,
"minItems": 1,
"uniqueItems": true
},
"hotspotConfiguration": {
"$ref": "#/components/schemas/Wifi hotspot configuration"
},
"mloEnabled": {
"type": "boolean"
},
"bandSteeringEnabled": {
"type": "boolean"
},
"arpProxyEnabled": {
"type": "boolean"
},
"bssTransitionEnabled": {
"type": "boolean"
},
"advertiseDeviceName": {
"type": "boolean",
"description": "Indicates whether the device name is advertised in beacon frames."
},
"dtimPeriodByFrequencyGHzOverride": {
"$ref": "#/components/schemas/IntegrationWifiDtimPeriodConfigurationDto"
}
},
"required": [
"advertiseDeviceName",
"arpProxyEnabled",
"broadcastingFrequenciesGHz",
"bssTransitionEnabled",
"clientIsolationEnabled",
"enabled",
"hideName",
"multicastToUnicastConversionEnabled",
"name",
"securityConfiguration",
"uapsdEnabled"
]
}
]
},
"IntegrationWifiBasicDataRateConfigurationDto": {
"type": "object",
"properties": {
"2.4": {
"type": "integer",
"format": "int32",
"enum": [
"1000",
"2000",
"5500",
"6000",
"9000",
"11000",
"12000",
"24000"
],
"example": 2000
},
"5": {
"type": "integer",
"format": "int32",
"enum": [
"6000",
"9000",
"12000",
"24000"
],
"example": 6000
}
},
"required": [
"2.4",
"5"
]
},
"IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"day": {
"type": "string",
"enum": [
"SUN",
"MON",
"TUE",
"WED",
"THU",
"FRI",
"SAT"
]
}
},
"required": [
"day",
"type"
]
},
"IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto": {
"allOf": [
{
"$ref": "#/components/schemas/Blackout schedule configuration per day"
},
{
"type": "object",
"properties": {
"timeRanges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationTimeRangeDto"
},
"minItems": 1
}
},
"required": [
"day",
"timeRanges"
]
}
]
},
"IntegrationWifiBlackoutScheduleConfigurationTimeRangeDto": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"description": "Start time in 24-hour format (HH:mm)"
},
"endTime": {
"type": "string",
"description": "End time in 24-hour format (HH:mm)"
}
},
"required": [
"endTime",
"startTime"
]
},
"IntegrationWifiCaptivePortalConfigurationDetailDto": {
"$ref": "#/components/schemas/Wifi hotspot configuration"
},
"IntegrationWifiClientFilteringPolicyDto": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"ALLOW",
"BLOCK"
]
},
"macAddressFilter": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 512,
"minItems": 0,
"uniqueItems": true
}
},
"required": [
"action",
"macAddressFilter"
]
},
"IntegrationWifiDerivedNasIdDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi Radius NAS ID configuration"
},
{
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"DEVICE_MAC_ADDRESS",
"DEVICE_NAME",
"SITE_NAME",
"BSSID"
]
}
},
"required": [
"source"
]
}
]
},
"IntegrationWifiDeviceTagsFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Broadcasting device filter"
},
{
"type": "object",
"properties": {
"deviceTagIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"deviceTagIds"
]
}
]
},
"IntegrationWifiDevicesFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Broadcasting device filter"
},
{
"type": "object",
"properties": {
"deviceIds": {
"type": "array",
"description": "List of Access Point capable device IDs to which the WiFi broadcast applies.",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"deviceIds"
]
}
]
},
"IntegrationWifiDtimPeriodConfigurationDto": {
"type": "object",
"properties": {
"2.4": {
"type": "integer",
"format": "int32",
"maximum": 255,
"minimum": 1
},
"5": {
"type": "integer",
"format": "int32",
"maximum": 255,
"minimum": 1
},
"6": {
"type": "integer",
"format": "int32",
"maximum": 255,
"minimum": 1
}
},
"required": [
"2.4",
"5",
"6"
]
},
"IntegrationWifiEnterpriseRadiusConfigurationDto": {
"type": "object",
"properties": {
"profileId": {
"type": "string",
"format": "uuid"
},
"nasId": {
"$ref": "#/components/schemas/Wifi Radius NAS ID configuration"
},
"macAuthenticationConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiRadiusMacAuthenticationConfigurationDto"
}
},
"required": [
"nasId",
"profileId"
]
},
"IntegrationWifiMdnsProxyAllowPolicyDto": {
"allOf": [
{
"$ref": "#/components/schemas/mDNS proxy policy"
},
{
"type": "object",
"properties": {
"serviceFilter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mDNS service"
},
"maxItems": 2147483647,
"minItems": 1
},
"bridgingNetworkIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 2147483647,
"minItems": 1,
"uniqueItems": true
}
}
}
]
},
"IntegrationWifiMdnsProxyAutoConfigurationDto": {
"$ref": "#/components/schemas/mDNS filtering configuration"
},
"IntegrationWifiMdnsProxyBlockPolicyDto": {
"$ref": "#/components/schemas/mDNS proxy policy"
},
"IntegrationWifiMdnsProxyCustomConfigurationDto": {
"allOf": [
{
"$ref": "#/components/schemas/mDNS filtering configuration"
},
{
"type": "object",
"properties": {
"policies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mDNS proxy policy"
},
"minItems": 1
}
},
"required": [
"policies"
]
}
]
},
"IntegrationWifiMdnsProxyCustomServiceDto": {
"allOf": [
{
"$ref": "#/components/schemas/mDNS service"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"typeDomain": {
"type": "string",
"minLength": 1
}
},
"required": [
"name",
"typeDomain"
]
}
]
},
"IntegrationWifiMdnsProxyPredefinedServiceDto": {
"allOf": [
{
"$ref": "#/components/schemas/mDNS service"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AMAZON_DEVICES",
"ANDROID_TV_REMOTE",
"APPLE_AIR_DROP",
"APPLE_AIR_PLAY",
"APPLE_FILE_SHARING",
"APPLE_ICHAT",
"APPLE_ITUNES",
"AQARA",
"BOSE",
"DNS_SERVICE_DISCOVERY",
"FTP_SERVERS",
"GOOGLE_CHROMECAST",
"HOMEKIT",
"MATTER_NETWORK",
"PHILIPS_HUE",
"PRINTERS",
"ROKU",
"SCANNERS",
"SONOS",
"SPOTIFY_CONNECT",
"SSH_SERVERS",
"TIME_CAPSULE",
"WEB_SERVERS",
"WINDOWS_FILE_SHARING_SAMBA"
]
}
},
"required": [
"name"
]
}
]
},
"IntegrationWifiMulticastFilteringAllowPolicyDto": {
"allOf": [
{
"$ref": "#/components/schemas/Multicast filtering policy"
},
{
"type": "object",
"properties": {
"sourceMacAddressFilter": {
"type": "array",
"description": "List of multicast source MAC addresses allowed. Multicast traffic from gateways is always allowed.",
"items": {
"type": "string"
},
"maxItems": 256,
"minItems": 0,
"uniqueItems": true
}
},
"required": [
"sourceMacAddressFilter"
]
}
]
},
"IntegrationWifiMulticastFilteringBlockPolicyDto": {
"$ref": "#/components/schemas/Multicast filtering policy"
},
"IntegrationWifiNativeNetworkDto": {
"$ref": "#/components/schemas/Wifi network reference"
},
"IntegrationWifiNonEnterpriseRadiusConfigurationDto": {
"type": "object",
"properties": {
"profileId": {
"type": "string",
"format": "uuid"
},
"nasId": {
"$ref": "#/components/schemas/Wifi Radius NAS ID configuration"
},
"macAuthenticationConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiRadiusMacAuthenticationConfigurationDto"
}
},
"required": [
"macAuthenticationConfiguration",
"nasId",
"profileId"
]
},
"IntegrationWifiOpenSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"type": "object",
"properties": {
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiNonEnterpriseRadiusConfigurationDto"
}
}
}
]
},
"IntegrationWifiPasspointConfigurationDetailDto": {
"$ref": "#/components/schemas/Wifi hotspot configuration"
},
"IntegrationWifiPresharedKeyDto": {
"type": "object",
"properties": {
"network": {
"$ref": "#/components/schemas/Wifi network reference"
},
"passphrase": {
"type": "string"
}
},
"required": [
"network",
"passphrase"
]
},
"IntegrationWifiRadiusMacAuthenticationConfigurationDto": {
"type": "object",
"properties": {
"macAddressFormat": {
"type": "string",
"enum": [
"UPPERCASE_NOT_SEPARATED",
"UPPERCASE_DASH_SEPARATED",
"UPPERCASE_COLON_SEPARATED",
"LOWERCASE_NOT_SEPARATED",
"LOWERCASE_COLON_SEPARATED",
"LOWERCASE_DASH_SEPARATED"
]
}
},
"required": [
"macAddressFormat"
]
},
"IntegrationWifiSaeConfigurationDto": {
"type": "object",
"properties": {
"anticloggingThresholdSeconds": {
"type": "integer",
"format": "int32",
"maximum": 60,
"minimum": 1
},
"syncTimeSeconds": {
"type": "integer",
"format": "int32",
"maximum": 60,
"minimum": 1
}
},
"required": [
"anticloggingThresholdSeconds",
"syncTimeSeconds"
]
},
"IntegrationWifiSpecificNetworkDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi network reference"
},
{
"type": "object",
"properties": {
"networkId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"networkId"
]
}
]
},
"IntegrationWifiUserDefinedNasIdDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi Radius NAS ID configuration"
},
{
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"required": [
"value"
]
}
]
},
"IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"type": "object",
"properties": {
"groupRekeyIntervalSeconds": {
"type": "integer",
"format": "int32",
"description": "Group rekey interval in seconds. Sets how often connected device groups are assigned a new key. If null, then it is disabled. This feature is not available for IoT configuration.",
"maximum": 86400,
"minimum": 1
},
"fastRoamingEnabled": {
"type": "boolean",
"description": "Fast roaming enabled flag. This feature is not available for IoT configuration."
},
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiEnterpriseRadiusConfigurationDto"
},
"coaEnabled": {
"type": "boolean",
"description": "Indicates whether Change of Authorization (COA) is enabled"
},
"pmfMode": {
"type": "string",
"description": "Protected Management Frames mode. If null, then it is disabled. This feature is not available for IoT configuration.",
"enum": [
"REQUIRED",
"OPTIONAL"
]
}
},
"required": [
"coaEnabled",
"radiusConfiguration"
]
}
]
},
"IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"type": "object",
"properties": {
"groupRekeyIntervalSeconds": {
"type": "integer",
"format": "int32",
"description": "Group rekey interval in seconds. Sets how often connected device groups are assigned a new key. If null, then it is disabled. This feature is not available for IoT configuration.",
"maximum": 86400,
"minimum": 1
},
"fastRoamingEnabled": {
"type": "boolean",
"description": "Fast roaming enabled flag. This feature is not available for IoT configuration."
},
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiNonEnterpriseRadiusConfigurationDto"
},
"passphrase": {
"type": "string",
"maxLength": 63,
"minLength": 8
},
"presharedKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationWifiPresharedKeyDto"
},
"maxItems": 2147483647,
"minItems": 1
},
"pmfMode": {
"type": "string",
"description": "Protected Management Frames mode. If null, then it is disabled. This feature is not available for IoT configuration.",
"enum": [
"REQUIRED",
"OPTIONAL"
]
}
}
}
]
},
"IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"type": "object",
"properties": {
"groupRekeyIntervalSeconds": {
"type": "integer",
"format": "int32",
"description": "Group rekey interval in seconds. Sets how often connected device groups are assigned a new key. If null, then it is disabled. This feature is not available for IoT configuration.",
"maximum": 86400,
"minimum": 1
},
"fastRoamingEnabled": {
"type": "boolean",
"description": "Fast roaming enabled flag. This feature is not available for IoT configuration."
},
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiEnterpriseRadiusConfigurationDto"
},
"coaEnabled": {
"type": "boolean",
"description": "Indicates whether Change of Authorization (COA) is enabled"
},
"pmfMode": {
"type": "string",
"description": "Protected Management Frames mode. If null, then it is disabled. This feature is not available for IoT configuration.",
"enum": [
"REQUIRED",
"OPTIONAL"
]
},
"wpa3FastRoamingEnabled": {
"type": "boolean",
"description": "WPA3 fast roaming can be enabled only if the default fast roaming is enabled"
}
},
"required": [
"coaEnabled",
"pmfMode",
"radiusConfiguration",
"wpa3FastRoamingEnabled"
]
}
]
},
"IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"type": "object",
"properties": {
"groupRekeyIntervalSeconds": {
"type": "integer",
"format": "int32",
"description": "Group rekey interval in seconds. Sets how often connected device groups are assigned a new key. If null, then it is disabled. This feature is not available for IoT configuration.",
"maximum": 86400,
"minimum": 1
},
"fastRoamingEnabled": {
"type": "boolean",
"description": "Fast roaming enabled flag. This feature is not available for IoT configuration."
},
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiNonEnterpriseRadiusConfigurationDto"
},
"passphrase": {
"type": "string",
"maxLength": 63,
"minLength": 8
},
"pmfMode": {
"type": "string",
"description": "Protected Management Frames mode. If null, then it is disabled. This feature is not available for IoT configuration.",
"enum": [
"REQUIRED",
"OPTIONAL"
]
},
"saeConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiSaeConfigurationDto",
"description": "Configuration for SAE (Simultaneous Authentication of Equals)."
},
"wpa3FastRoamingEnabled": {
"type": "boolean",
"description": "WPA3 fast roaming can be enabled only if the default fast roaming is enabled"
}
},
"required": [
"passphrase",
"pmfMode",
"saeConfiguration",
"wpa3FastRoamingEnabled"
]
}
]
},
"IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"type": "object",
"properties": {
"groupRekeyIntervalSeconds": {
"type": "integer",
"format": "int32",
"description": "Group rekey interval in seconds. Sets how often connected device groups are assigned a new key. If null, then it is disabled. This feature is not available for IoT configuration.",
"maximum": 86400,
"minimum": 1
},
"fastRoamingEnabled": {
"type": "boolean",
"description": "Fast roaming enabled flag. This feature is not available for IoT configuration."
},
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiEnterpriseRadiusConfigurationDto"
},
"coaEnabled": {
"type": "boolean",
"description": "Indicates whether Change of Authorization (COA) is enabled"
},
"securityMode": {
"type": "string",
"enum": [
"DEFAULT",
"HIGH_SECURITY_192_BIT"
]
}
},
"required": [
"coaEnabled",
"radiusConfiguration",
"securityMode"
]
}
]
},
"IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
{
"type": "object",
"properties": {
"groupRekeyIntervalSeconds": {
"type": "integer",
"format": "int32",
"description": "Group rekey interval in seconds. Sets how often connected device groups are assigned a new key. If null, then it is disabled. This feature is not available for IoT configuration.",
"maximum": 86400,
"minimum": 1
},
"fastRoamingEnabled": {
"type": "boolean",
"description": "Fast roaming enabled flag. This feature is not available for IoT configuration."
},
"radiusConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiNonEnterpriseRadiusConfigurationDto"
},
"passphrase": {
"type": "string",
"maxLength": 63,
"minLength": 8
},
"saeConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiSaeConfigurationDto",
"description": "Configuration for SAE (Simultaneous Authentication of Equals)."
}
},
"required": [
"passphrase",
"saeConfiguration"
]
}
]
},
"Multicast filtering policy": {
"properties": {
"action": {
"type": "string"
}
},
"required": [
"action"
],
"type": "object"
},
"Wifi Radius NAS ID configuration": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Wifi broadcast create or update": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"network": {
"$ref": "#/components/schemas/Wifi network reference"
},
"enabled": {
"type": "boolean"
},
"securityConfiguration": {
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
"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."
},
"mdnsProxyConfiguration": {
"$ref": "#/components/schemas/mDNS filtering configuration"
},
"multicastFilteringPolicy": {
"$ref": "#/components/schemas/Multicast filtering policy"
},
"multicastToUnicastConversionEnabled": {
"type": "boolean"
},
"clientIsolationEnabled": {
"type": "boolean"
},
"hideName": {
"type": "boolean"
},
"uapsdEnabled": {
"type": "boolean",
"description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"
},
"basicDataRateKbpsByFrequencyGHz": {
"$ref": "#/components/schemas/IntegrationWifiBasicDataRateConfigurationDto"
},
"clientFilteringPolicy": {
"$ref": "#/components/schemas/IntegrationWifiClientFilteringPolicyDto",
"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses."
},
"blackoutScheduleConfiguration": {
"$ref": "#/components/schemas/Integration blackout schedule configuration"
}
},
"required": [
"clientIsolationEnabled",
"enabled",
"hideName",
"multicastToUnicastConversionEnabled",
"name",
"securityConfiguration",
"type",
"uapsdEnabled"
]
},
"Wifi hotspot configuration": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Wifi network reference": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Wifi security configuration detailObject": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"radiusConfiguration": {}
},
"required": [
"type"
]
},
"mDNS filtering configuration": {
"properties": {
"mode": {
"type": "string"
}
},
"required": [
"mode"
],
"type": "object"
},
"mDNS proxy policy": {
"type": "object",
"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"
]
},
"mDNS service": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Derived entity metadata": {
"$ref": "#/components/schemas/Entity metadata"
},
"Entity metadata": {
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
],
"type": "object"
},
"IntegrationDerivedSiteToSiteTunnelMetadata": {
"allOf": [
{
"$ref": "#/components/schemas/Site-to-site VPN tunnel metadata"
},
{
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"SDWAN"
]
}
},
"required": [
"source"
]
}
]
},
"IntegrationIotOptimizedWifiBroadcastDetailDto": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/User or derived or orchestrated entity metadata"
},
"enabled": {
"type": "boolean"
},
"network": {
"$ref": "#/components/schemas/Wifi network reference"
},
"securityConfiguration": {
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
"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."
},
"mdnsProxyConfiguration": {
"$ref": "#/components/schemas/mDNS filtering configuration"
},
"multicastFilteringPolicy": {
"$ref": "#/components/schemas/Multicast filtering policy"
},
"multicastToUnicastConversionEnabled": {
"type": "boolean"
},
"clientIsolationEnabled": {
"type": "boolean"
},
"hideName": {
"type": "boolean"
},
"uapsdEnabled": {
"type": "boolean",
"description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"
},
"basicDataRateKbpsByFrequencyGHz": {
"$ref": "#/components/schemas/IntegrationWifiBasicDataRateConfigurationDto"
},
"clientFilteringPolicy": {
"$ref": "#/components/schemas/IntegrationWifiClientFilteringPolicyDto",
"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses."
},
"blackoutScheduleConfiguration": {
"$ref": "#/components/schemas/Integration blackout schedule configuration"
}
},
"required": [
"clientIsolationEnabled",
"enabled",
"hideName",
"id",
"metadata",
"multicastToUnicastConversionEnabled",
"name",
"securityConfiguration",
"type",
"uapsdEnabled"
]
},
"IntegrationStandardWifiBroadcastDetailDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi broadcast details"
},
{
"type": "object",
"properties": {
"broadcastingFrequenciesGHz": {
"type": "array",
"example": [
2.4,
5
],
"items": {
"type": "number",
"enum": [
2.4,
5.0,
6.0
]
},
"maxItems": 2147483647,
"minItems": 1,
"uniqueItems": true
},
"hotspotConfiguration": {
"$ref": "#/components/schemas/Wifi hotspot configuration"
},
"mloEnabled": {
"type": "boolean"
},
"bandSteeringEnabled": {
"type": "boolean"
},
"arpProxyEnabled": {
"type": "boolean"
},
"bssTransitionEnabled": {
"type": "boolean"
},
"advertiseDeviceName": {
"type": "boolean",
"description": "Indicates whether the device name is advertised in beacon frames."
},
"dtimPeriodByFrequencyGHzOverride": {
"$ref": "#/components/schemas/IntegrationWifiDtimPeriodConfigurationDto"
}
},
"required": [
"advertiseDeviceName",
"arpProxyEnabled",
"broadcastingFrequenciesGHz",
"bssTransitionEnabled",
"clientIsolationEnabled",
"enabled",
"hideName",
"id",
"metadata",
"multicastToUnicastConversionEnabled",
"name",
"securityConfiguration",
"uapsdEnabled"
]
}
]
},
"Orchestrated entity metadata": {
"$ref": "#/components/schemas/Entity metadata"
},
"Site-to-site VPN tunnel metadata": {
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
],
"type": "object"
},
"System defined entity metadata": {
"$ref": "#/components/schemas/Entity metadata"
},
"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": {
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
],
"type": "object"
},
"User or derived or orchestrated entity metadata": {
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
],
"type": "object"
},
"User or orchestrated entity metadata": {
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
],
"type": "object"
},
"User or system defined entity metadata": {
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
],
"type": "object"
},
"User or system defined or orchestrated entity metadata": {
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
],
"type": "object"
},
"Wifi broadcast details": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/User or derived or orchestrated entity metadata"
},
"enabled": {
"type": "boolean"
},
"network": {
"$ref": "#/components/schemas/Wifi network reference"
},
"securityConfiguration": {
"$ref": "#/components/schemas/Wifi security configuration detailObject"
},
"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."
},
"mdnsProxyConfiguration": {
"$ref": "#/components/schemas/mDNS filtering configuration"
},
"multicastFilteringPolicy": {
"$ref": "#/components/schemas/Multicast filtering policy"
},
"multicastToUnicastConversionEnabled": {
"type": "boolean"
},
"clientIsolationEnabled": {
"type": "boolean"
},
"hideName": {
"type": "boolean"
},
"uapsdEnabled": {
"type": "boolean",
"description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"
},
"basicDataRateKbpsByFrequencyGHz": {
"$ref": "#/components/schemas/IntegrationWifiBasicDataRateConfigurationDto"
},
"clientFilteringPolicy": {
"$ref": "#/components/schemas/IntegrationWifiClientFilteringPolicyDto",
"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses."
},
"blackoutScheduleConfiguration": {
"$ref": "#/components/schemas/Integration blackout schedule configuration"
}
},
"required": [
"clientIsolationEnabled",
"enabled",
"hideName",
"id",
"metadata",
"multicastToUnicastConversionEnabled",
"name",
"securityConfiguration",
"type",
"uapsdEnabled"
]
},
"Address IPv4 matching": {
"allOf": [
{
"$ref": "#/components/schemas/IPv4 matching"
},
{
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "IPv4 address",
"example": "192.168.1.5"
}
},
"required": [
"value"
]
}
]
},
"Address IPv6 matching": {
"allOf": [
{
"$ref": "#/components/schemas/IPv6 matching"
},
{
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "IPv6 address",
"example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
}
},
"required": [
"value"
]
}
]
},
"Address range IPv4 matching": {
"allOf": [
{
"$ref": "#/components/schemas/IPv4 matching"
},
{
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "IPv4 start address",
"example": "192.168.1.10"
},
"stop": {
"type": "string",
"description": "IPv4 stop address",
"example": "192.168.1.20"
}
},
"required": [
"start",
"stop"
]
}
]
},
"Create or update traffic matching list": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string",
"example": "Allowed port list|Protected IP list",
"minLength": 1
}
},
"required": [
"name",
"type"
]
},
"IPv4 matching": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"IPv6 matching": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"IntegrationIpV4TrafficMatchingListCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update traffic matching list"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPv4 matching"
},
"minItems": 1
}
},
"required": [
"items",
"name"
]
}
]
},
"IntegrationIpV6TrafficMatchingListCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update traffic matching list"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPv6 matching"
},
"minItems": 1
}
},
"required": [
"items",
"name"
]
}
]
},
"IntegrationPortTrafficMatchingListCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update traffic matching list"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Port matching"
},
"minItems": 1
}
},
"required": [
"items",
"name"
]
}
]
},
"Number port matching": {
"allOf": [
{
"$ref": "#/components/schemas/Port matching"
},
{
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "int32",
"description": "Port number",
"example": "80|443|8080",
"maximum": 65535,
"minimum": 1
}
},
"required": [
"value"
]
}
]
},
"Number range port matching": {
"allOf": [
{
"$ref": "#/components/schemas/Port matching"
},
{
"type": "object",
"properties": {
"start": {
"type": "integer",
"format": "int32",
"description": "Start port number",
"example": "80|443|8080",
"maximum": 65535,
"minimum": 1
},
"stop": {
"type": "integer",
"format": "int32",
"description": "Stop port number",
"example": "80|443|8080",
"maximum": 65535,
"minimum": 1
}
},
"required": [
"start",
"stop"
]
}
]
},
"Port matching": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Subnet IPv4 matching": {
"allOf": [
{
"$ref": "#/components/schemas/IPv4 matching"
},
{
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "IPv4 subnet in CIDR notation",
"example": "192.168.1.0/24"
}
},
"required": [
"value"
]
}
]
},
"Subnet IPv6 matching": {
"allOf": [
{
"$ref": "#/components/schemas/IPv6 matching"
},
{
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "IPv6 subnet in CIDR notation",
"example": "2001:db8:1:0::/64"
}
},
"required": [
"value"
]
}
]
},
"IntegrationIpV4TrafficMatchingListDto": {
"allOf": [
{
"$ref": "#/components/schemas/Traffic matching list"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPv4 matching"
},
"minItems": 1
}
},
"required": [
"id",
"items",
"name"
]
}
]
},
"IntegrationIpV6TrafficMatchingListDto": {
"allOf": [
{
"$ref": "#/components/schemas/Traffic matching list"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPv6 matching"
},
"minItems": 1
}
},
"required": [
"id",
"items",
"name"
]
}
]
},
"IntegrationPortTrafficMatchingListDto": {
"allOf": [
{
"$ref": "#/components/schemas/Traffic matching list"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Port matching"
},
"minItems": 1
}
},
"required": [
"id",
"items",
"name"
]
}
]
},
"Traffic matching list": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid",
"example": "ffcdb32c-6278-4364-8947-df4f77118df8"
},
"name": {
"type": "string",
"example": "Allowed port list|Protected IP list",
"minLength": 1
}
},
"required": [
"id",
"name",
"type"
]
},
"Create or update Network": {
"type": "object",
"properties": {
"management": {
"type": "string"
},
"name": {
"type": "string",
"example": "Default Network"
},
"enabled": {
"type": "boolean"
},
"vlanId": {
"type": "integer",
"format": "int32",
"description": "VLAN ID. Must be 1 for the default network and >= 2 for additional networks.",
"maximum": 4009,
"minimum": 1
},
"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"
}
},
"required": [
"enabled",
"management",
"name",
"vlanId"
]
},
"DHCP Configuration for IPv6 Network": {
"type": "object",
"properties": {
"ipAddressSuffixRange": {
"$ref": "#/components/schemas/IntegrationIpv6AddressSuffixRangeSelectorDto"
},
"leaseTimeSeconds": {
"type": "integer",
"format": "int32",
"description": "The lease time in seconds for IP addresses in this range.",
"maximum": 31536000,
"minimum": 0
}
},
"required": [
"ipAddressSuffixRange",
"leaseTimeSeconds"
]
},
"Gateway Managed IPv4 Configuration": {
"type": "object",
"properties": {
"autoScaleEnabled": {
"type": "boolean",
"description": "Whether the Network can automatically scale its subnet size based on the number of active DHCP leases."
},
"hostIpAddress": {
"type": "string"
},
"prefixLength": {
"type": "integer",
"format": "int32",
"maximum": 30,
"minimum": 8
},
"additionalHostIpSubnets": {
"type": "array",
"description": "Additional host IP subnets assigned to this VLAN.",
"items": {
"type": "string"
},
"maxItems": 64,
"minItems": 1
},
"dhcpConfiguration": {
"$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."
},
"natOutboundIpAddressConfiguration": {
"type": "array",
"description": "List of NAT Outbound Configurations defining which IP addresses are used for NAT translation. This array must contain all WAN interfaces with `static` or `PPPoE` IPv4 connection configuration.",
"items": {
"$ref": "#/components/schemas/WAN NAT Outbound Configuration"
},
"maxItems": 2147483647,
"minItems": 1
}
},
"required": [
"autoScaleEnabled",
"hostIpAddress",
"prefixLength"
]
},
"Gateway Managed IPv4 DHCP Configuration": {
"properties": {
"mode": {
"type": "string"
}
},
"required": [
"mode"
],
"type": "object"
},
"Gateway Managed IPv4 DHCP Server Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/Gateway Managed IPv4 DHCP Configuration"
},
{
"type": "object",
"properties": {
"ipAddressRange": {
"$ref": "#/components/schemas/IP address range"
},
"gatewayIpAddressOverride": {
"type": "string",
"description": "Gateway IP address provided to DHCP clients. If null, the default gateway will be assigned."
},
"dnsServerIpAddressesOverride": {
"type": "array",
"description": "List of DNS servers assigned to client devices by the DHCP server. If none are specified, they will be selected automatically.",
"items": {
"type": "string"
},
"maxItems": 4,
"minItems": 1
},
"leaseTimeSeconds": {
"type": "integer",
"format": "int32",
"description": "The lease time in seconds for addresses in this range.",
"maximum": 31536000,
"minimum": 0
},
"domainName": {
"type": "string",
"description": "Domain name that can be used to access network in the browser."
},
"pingConflictDetectionEnabled": {
"type": "boolean"
},
"pxeConfiguration": {
"$ref": "#/components/schemas/PXE Configuration",
"description": "Pre execution environment configuration for network boot"
},
"ntpServerIpAddresses": {
"type": "array",
"description": "Network Time Protocol (NTP) server IP addresses.",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1
},
"option43Value": {
"type": "string",
"description": "Custom DHCP option (43) \u2014 the value MUST be the UniFi Network application's host IP address."
},
"tftpServerAddress": {
"type": "string",
"description": "Trivial File Transfer Protocol (TFTP) server address \u2014 accepts a hostname, URL or IP address."
},
"timeOffsetSeconds": {
"type": "integer",
"format": "int32",
"description": "Time offset in seconds from UTC.",
"maximum": 86400,
"minimum": -86400
},
"wpadUrl": {
"type": "string",
"description": "Web Proxy Auto-Discovery (WPAD) URL."
},
"winsServerIpAddresses": {
"type": "array",
"description": "Windows Internet Name Service (WINS) server IP addresses.",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1
}
},
"required": [
"ipAddressRange",
"leaseTimeSeconds",
"pingConflictDetectionEnabled"
]
}
]
},
"IP Address selector": {
"allOf": [
{
"$ref": "#/components/schemas/IP address selector"
},
{
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"required": [
"value"
]
}
]
},
"IP address range": {
"type": "object",
"properties": {
"start": {
"type": "string"
},
"stop": {
"type": "string"
}
},
"required": [
"start",
"stop"
]
},
"IP address range selector": {
"allOf": [
{
"$ref": "#/components/schemas/IP address selector"
},
{
"type": "object",
"properties": {
"start": {
"type": "string"
},
"stop": {
"type": "string"
}
},
"required": [
"start",
"stop"
]
}
]
},
"IP address selector": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"IPv4 DHCP Relay Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/Gateway Managed IPv4 DHCP Configuration"
},
{
"type": "object",
"properties": {
"dhcpServerIpAddresses": {
"type": "array",
"description": "DHCP Server IP addresses",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": [
"dhcpServerIpAddresses"
]
},
{
"$ref": "#/components/schemas/Switch Managed IPv4 DHCP Configuration"
}
]
},
"IPv4 DHCP Server Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/Switch Managed IPv4 DHCP Configuration"
},
{
"type": "object",
"properties": {
"ipAddressRange": {
"$ref": "#/components/schemas/IP address range"
},
"gatewayIpAddressOverride": {
"type": "string",
"description": "Gateway IP address provided to DHCP clients. If null, the default gateway will be assigned."
},
"dnsServerIpAddressesOverride": {
"type": "array",
"description": "List of DNS servers assigned to client devices by the DHCP server. If none are specified, they will be selected automatically.",
"items": {
"type": "string"
},
"maxItems": 4,
"minItems": 1
},
"leaseTimeSeconds": {
"type": "integer",
"format": "int32",
"description": "The lease time in seconds for addresses in this range.",
"maximum": 31536000,
"minimum": 0
},
"domainName": {
"type": "string",
"description": "Domain name that can be used to access network in the browser."
}
},
"required": [
"ipAddressRange",
"leaseTimeSeconds"
]
}
]
},
"IPv6 Client Address Assignment": {
"type": "object",
"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": {
"type": "boolean",
"description": "Allows devices to obtain IPv6 addresses via SLAAC (Stateless Address Autoconfiguration) without DHCPv6. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration."
}
},
"required": [
"slaacEnabled"
]
},
"IPv6 Static Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/Network IPv6 Configuration"
},
{
"type": "object",
"properties": {
"hostIpAddress": {
"type": "string",
"description": "The static IPv6 address assigned to this Network."
},
"prefixLength": {
"type": "integer",
"format": "int32",
"maximum": 127,
"minimum": 64
}
},
"required": [
"clientAddressAssignment",
"hostIpAddress",
"prefixLength"
]
}
]
},
"IntegrationGatewayManagedNetworkCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update Network"
},
{
"type": "object",
"properties": {
"isolationEnabled": {
"type": "boolean",
"description": "Whether this network is isolated from all other networks."
},
"cellularBackupEnabled": {
"type": "boolean",
"description": "Whether this network is allowed to use cellular data when WAN connection(s) are down."
},
"zoneId": {
"type": "string",
"format": "uuid",
"description": "Firewall zone ID associated with this Network."
},
"internetAccessEnabled": {
"type": "boolean",
"description": "Whether the internet access is allowed for the device on this network."
},
"mdnsForwardingEnabled": {
"type": "boolean",
"description": "Whether this network should participate in mDNS traffic forwarding."
},
"ipv4Configuration": {
"$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."
}
},
"required": [
"cellularBackupEnabled",
"enabled",
"internetAccessEnabled",
"ipv4Configuration",
"isolationEnabled",
"mdnsForwardingEnabled",
"name",
"vlanId"
]
}
]
},
"IntegrationIpv6AddressSuffixRangeSelectorDto": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "Start suffix of the DHCPv6 address pool."
},
"stop": {
"type": "string",
"description": "End suffix of the DHCPv6 address pool."
}
},
"required": [
"start",
"stop"
]
},
"IntegrationSwitchManagedNetworkCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update Network"
},
{
"type": "object",
"properties": {
"isolationEnabled": {
"type": "boolean",
"description": "Whether this network is isolated from all other networks."
},
"cellularBackupEnabled": {
"type": "boolean",
"description": "Whether this network is allowed to use cellular data when WAN connection(s) are down."
},
"deviceId": {
"type": "string",
"format": "uuid",
"description": "ID of the L3 switching capable device that manages this network."
},
"ipv4Configuration": {
"$ref": "#/components/schemas/Switch Managed IPv4 Configuration",
"description": "Details about IPv4 configuration for this Network."
}
},
"required": [
"cellularBackupEnabled",
"deviceId",
"enabled",
"ipv4Configuration",
"isolationEnabled",
"name",
"vlanId"
]
}
]
},
"IntegrationUnmanagedNetworkCreateUpdateDto": {
"type": "object",
"properties": {
"management": {
"type": "string"
},
"name": {
"type": "string",
"example": "Default Network"
},
"enabled": {
"type": "boolean"
},
"vlanId": {
"type": "integer",
"format": "int32",
"description": "VLAN ID. Must be 1 for the default network and >= 2 for additional networks.",
"maximum": 4009,
"minimum": 1
},
"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"
}
},
"required": [
"enabled",
"management",
"name",
"vlanId"
]
},
"NAT Outbound Auto Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/WAN NAT Outbound Configuration"
},
{
"type": "object",
"properties": {
"ipAddressSelectionMode": {
"type": "string",
"description": "IP address selection mode which determines how the IP address will be selected from the group of IP addresses to translate the traffic on network using NAT.",
"enum": [
"MAIN",
"ALL"
]
}
},
"required": [
"ipAddressSelectionMode",
"wanInterfaceId"
]
}
]
},
"NAT Outbound Static Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/WAN NAT Outbound Configuration"
},
{
"type": "object",
"properties": {
"ipAddressSelectors": {
"type": "array",
"description": "List of IP addresses or address ranges which determines which IP addresses will be used to translate the traffic on network using NAT.",
"items": {
"$ref": "#/components/schemas/IP address selector"
},
"minItems": 1
}
},
"required": [
"ipAddressSelectors",
"wanInterfaceId"
]
}
]
},
"Network DHCP Guarding": {
"type": "object",
"description": "Details about DHCP Guarding settings for this Network.",
"properties": {
"trustedDhcpServerIpAddresses": {
"type": "array",
"description": "List of trusted DHCP server IP addresses.",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": [
"trustedDhcpServerIpAddresses"
]
},
"Network IPv6 Configuration": {
"type": "object",
"properties": {
"interfaceType": {
"type": "string"
},
"clientAddressAssignment": {
"$ref": "#/components/schemas/IPv6 Client Address Assignment",
"description": "Client Address Assignment"
},
"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."
},
"dnsServerIpAddressesOverride": {
"type": "array",
"description": "The IPv6 DNS server addresses assigned to this Network. If none are specified, they will be selected automatically.",
"items": {
"type": "string"
},
"maxItems": 4,
"minItems": 1
},
"additionalHostIpSubnets": {
"type": "array",
"description": "Additional host IP subnets assigned to this VLAN.",
"items": {
"type": "string"
},
"maxItems": 4,
"minItems": 1
}
},
"required": [
"clientAddressAssignment",
"interfaceType"
]
},
"PXE Configuration": {
"type": "object",
"properties": {
"serverIpAddress": {
"type": "string"
},
"filename": {
"type": "string",
"minLength": 1
}
},
"required": [
"filename",
"serverIpAddress"
]
},
"Prefix delegation IPv6 Configuration": {
"allOf": [
{
"$ref": "#/components/schemas/Network IPv6 Configuration"
},
{
"type": "object",
"properties": {
"prefixDelegationWanInterfaceId": {
"type": "string",
"format": "uuid",
"description": "ID of the WAN interface from which the prefix is delegated."
}
},
"required": [
"clientAddressAssignment",
"prefixDelegationWanInterfaceId"
]
}
]
},
"Router advertisement Configuration": {
"type": "object",
"properties": {
"priority": {
"type": "string",
"description": "Router advertisement priority.",
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
}
},
"required": [
"priority"
]
},
"Switch Managed IPv4 Configuration": {
"type": "object",
"properties": {
"autoScaleEnabled": {
"type": "boolean",
"description": "Whether the Network can automatically scale its subnet size based on the number of active DHCP leases."
},
"hostIpAddress": {
"type": "string"
},
"prefixLength": {
"type": "integer",
"format": "int32",
"maximum": 30,
"minimum": 8
},
"additionalHostIpSubnets": {
"type": "array",
"description": "Additional host IP subnets assigned to this VLAN.",
"items": {
"type": "string"
},
"maxItems": 64,
"minItems": 1
},
"dhcpConfiguration": {
"$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."
}
},
"required": [
"autoScaleEnabled",
"hostIpAddress",
"prefixLength"
]
},
"Switch Managed IPv4 DHCP Configuration": {
"properties": {
"mode": {
"type": "string"
}
},
"required": [
"mode"
],
"type": "object"
},
"WAN NAT Outbound Configuration": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"wanInterfaceId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"type",
"wanInterfaceId"
]
},
"Gateway managed network details": {
"allOf": [
{
"$ref": "#/components/schemas/Network details"
},
{
"type": "object",
"properties": {
"isolationEnabled": {
"type": "boolean",
"description": "Whether this network is isolated from all other networks."
},
"cellularBackupEnabled": {
"type": "boolean",
"description": "Whether this network is allowed to use cellular data when WAN connection(s) are down."
},
"zoneId": {
"type": "string",
"format": "uuid",
"description": "Firewall zone ID associated with this Network."
},
"internetAccessEnabled": {
"type": "boolean",
"description": "Whether the internet access is allowed for the device on this network."
},
"mdnsForwardingEnabled": {
"type": "boolean",
"description": "Whether this network should participate in mDNS traffic forwarding."
},
"ipv4Configuration": {
"$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."
}
},
"required": [
"cellularBackupEnabled",
"default",
"enabled",
"id",
"internetAccessEnabled",
"ipv4Configuration",
"isolationEnabled",
"mdnsForwardingEnabled",
"metadata",
"name",
"vlanId"
]
}
]
},
"Network details": {
"type": "object",
"properties": {
"management": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"example": "Default Network",
"minLength": 1
},
"enabled": {
"type": "boolean"
},
"vlanId": {
"type": "integer",
"format": "int32",
"description": "VLAN ID. Must be 1 for the default network and >= 2 for additional networks.",
"maximum": 4009,
"minimum": 1
},
"metadata": {
"$ref": "#/components/schemas/User or system defined or orchestrated entity metadata",
"description": "Orchestrated or System-defined configurable network support"
},
"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"
},
"default": {
"type": "boolean"
}
},
"required": [
"default",
"enabled",
"id",
"management",
"metadata",
"name",
"vlanId"
]
},
"Switch managed network details": {
"allOf": [
{
"$ref": "#/components/schemas/Network details"
},
{
"type": "object",
"properties": {
"isolationEnabled": {
"type": "boolean",
"description": "Whether this network is isolated from all other networks."
},
"cellularBackupEnabled": {
"type": "boolean",
"description": "Whether this network is allowed to use cellular data when WAN connection(s) are down."
},
"deviceId": {
"type": "string",
"format": "uuid",
"description": "ID of the L3 switching capable device that manages this network."
},
"ipv4Configuration": {
"$ref": "#/components/schemas/Switch Managed IPv4 Configuration",
"description": "Details about IPv4 configuration for this Network."
}
},
"required": [
"cellularBackupEnabled",
"default",
"deviceId",
"enabled",
"id",
"ipv4Configuration",
"isolationEnabled",
"metadata",
"name",
"vlanId"
]
}
]
},
"Unmanaged network details": {
"type": "object",
"properties": {
"management": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"example": "Default Network",
"minLength": 1
},
"enabled": {
"type": "boolean"
},
"vlanId": {
"type": "integer",
"format": "int32",
"description": "VLAN ID. Must be 1 for the default network and >= 2 for additional networks.",
"maximum": 4009,
"minimum": 1
},
"metadata": {
"$ref": "#/components/schemas/User or system defined or orchestrated entity metadata",
"description": "Orchestrated or System-defined configurable network support"
},
"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"
},
"default": {
"type": "boolean"
}
},
"required": [
"default",
"enabled",
"id",
"management",
"metadata",
"name",
"vlanId"
]
},
"Create or update firewall zone": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of a firewall zone",
"example": "Hotspot|My custom zone"
},
"networkIds": {
"type": "array",
"description": "List of Network IDs",
"items": {
"type": "string",
"format": "uuid",
"example": "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b"
},
"minItems": 0
}
},
"required": [
"name",
"networkIds"
]
},
"Firewall zone": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "ffcdb32c-6278-4364-8947-df4f77118df8"
},
"name": {
"type": "string",
"description": "Name of a firewall zone",
"example": "Hotspot|My custom zone"
},
"networkIds": {
"type": "array",
"description": "List of Network IDs",
"items": {
"type": "string",
"format": "uuid",
"example": "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b"
},
"minItems": 0
},
"metadata": {
"$ref": "#/components/schemas/User or system defined entity metadata",
"description": "System-defined configurable zones support configuring only attached networks"
}
},
"required": [
"id",
"metadata",
"name",
"networkIds"
]
},
"Create or update firewall policy": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"name": {
"type": "string",
"example": "My firewall policy",
"minLength": 1
},
"description": {
"type": "string",
"example": "A description for my firewall policy"
},
"action": {
"$ref": "#/components/schemas/Firewall policy action"
},
"source": {
"$ref": "#/components/schemas/Firewall policy source"
},
"destination": {
"$ref": "#/components/schemas/Firewall policy destination"
},
"ipProtocolScope": {
"$ref": "#/components/schemas/Firewall policy IP protocol scope"
},
"connectionStateFilter": {
"type": "array",
"description": "Match on firewall connection state. If null, matches all connection states.",
"items": {
"type": "string",
"enum": [
"NEW",
"INVALID",
"ESTABLISHED",
"RELATED"
]
},
"maxItems": 2147483647,
"minItems": 1,
"uniqueItems": true
},
"ipsecFilter": {
"type": "string",
"description": "Match on traffic encrypted, or not encrypted by IPsec. If null, matches all traffic.",
"enum": [
"MATCH_ENCRYPTED",
"MATCH_NOT_ENCRYPTED"
]
},
"loggingEnabled": {
"type": "boolean",
"description": "Generate syslog entries when traffic is matched. Such entries are sent to a remote syslog server."
},
"schedule": {
"$ref": "#/components/schemas/Firewall schedule"
}
},
"required": [
"action",
"destination",
"enabled",
"ipProtocolScope",
"loggingEnabled",
"name",
"source"
]
},
"Firewall policy IP address filter": {
"type": "object",
"description": "Match traffic originating from, or destined to selected IP addresses.",
"properties": {
"type": {
"type": "string"
},
"matchOpposite": {
"type": "boolean",
"description": "Match on all IP addresses except the specified ones."
}
},
"required": [
"matchOpposite",
"type"
]
},
"Firewall policy IP protocol scope": {
"description": "Defines rules for matching by IP version and protocol.",
"properties": {
"ipVersion": {
"type": "string"
}
},
"required": [
"ipVersion"
],
"type": "object"
},
"Firewall policy IPv4 and IPv6 named protocol": {
"type": "object",
"description": "Defines rules for matching by protocol name.",
"properties": {
"name": {
"type": "string",
"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"
]
}
},
"required": [
"name"
]
},
"Firewall policy IPv4 and IPv6 protocol": {
"description": "Defines protocol matching. If null, matches all protocols.",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Firewall policy IPv4 and IPv6 protocol number": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 protocol"
},
{
"type": "object",
"properties": {
"protocolNumber": {
"type": "integer",
"format": "int32",
"description": "Protocol number as defined by IANA.",
"maximum": 255,
"minimum": 0
},
"matchOpposite": {
"type": "boolean",
"description": "Match on all protocols except the specified protocol."
}
},
"required": [
"matchOpposite",
"protocolNumber"
]
}
],
"description": "Defines rules for matching by protocol number."
},
"Firewall policy IPv4 and IPv6 protocol preset": {
"description": "Defines rules for matching by protocol preset.",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Firewall policy IPv4 named protocol": {
"type": "object",
"description": "Defines rules for matching by protocol name.",
"properties": {
"name": {
"type": "string",
"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"
]
}
}
},
"Firewall policy IPv4 protocol": {
"description": "Defines protocol matching. If null, matches all protocols.",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Firewall policy IPv4 protocol number": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv6 protocol"
},
{
"type": "object",
"properties": {
"protocolNumber": {
"type": "integer",
"format": "int32",
"description": "Protocol number as defined by IANA.",
"maximum": 255,
"minimum": 0
},
"matchOpposite": {
"type": "boolean",
"description": "Match on all protocols except the specified protocol."
}
},
"required": [
"matchOpposite",
"protocolNumber"
]
}
],
"description": "Defines rules for matching by protocol number."
},
"Firewall policy IPv4 protocol preset": {
"description": "Defines rules for matching by protocol preset.",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Firewall policy IPv6 interface identifier filter": {
"type": "object",
"properties": {
"ipv6Iid": {
"type": "string",
"description": "IPv6 Interface Identifier.",
"example": "2001:db8::1/::ffff:ffff:ffff:ffff",
"minLength": 1
},
"matchOpposite": {
"type": "boolean",
"description": "Match on all IPv6 IIDs except the specified one."
}
},
"required": [
"ipv6Iid",
"matchOpposite"
]
},
"Firewall policy IPv6 named protocol": {
"type": "object",
"description": "Defines rules for matching by protocol name.",
"properties": {
"name": {
"type": "string",
"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"
]
}
}
},
"Firewall policy IPv6 protocol": {
"description": "Defines protocol matching. If null, matches all protocols.",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Firewall policy IPv6 protocol preset": {
"description": "Defines rules for matching by protocol preset.",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Firewall policy MAC address filter": {
"type": "object",
"properties": {
"macAddresses": {
"type": "array",
"description": "Array of MAC addresses to match.",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"macAddresses"
]
},
"Firewall policy VPN server filter": {
"type": "object",
"properties": {
"vpnServerIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"uniqueItems": true
},
"matchOpposite": {
"type": "boolean"
}
},
"required": [
"matchOpposite",
"vpnServerIds"
]
},
"Firewall policy action": {
"description": "Defines action for matched traffic.",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Firewall policy application category filter": {
"type": "object",
"properties": {
"applicationCategoryIds": {
"type": "array",
"description": "Array of DPI Category IDs to match.",
"items": {
"type": "integer",
"format": "int32"
},
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"applicationCategoryIds"
]
},
"Firewall policy application filter": {
"type": "object",
"properties": {
"applicationIds": {
"type": "array",
"description": "Array of DPI Application IDs to match.",
"items": {
"type": "integer",
"format": "int32"
},
"maxItems": 100,
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"applicationIds"
]
},
"Firewall policy destination": {
"type": "object",
"properties": {
"zoneId": {
"type": "string",
"format": "uuid",
"description": "ID of the firewall zone to which the matched traffic is destined."
},
"trafficFilter": {
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
}
},
"required": [
"zoneId"
]
},
"Firewall policy destination traffic filter": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Firewall policy domain filter": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Firewall policy network filter": {
"type": "object",
"properties": {
"networkIds": {
"type": "array",
"description": "Array of Network IDs to match.",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"uniqueItems": true
},
"matchOpposite": {
"type": "boolean",
"description": "Match on all Networks except the selected."
}
},
"required": [
"matchOpposite",
"networkIds"
]
},
"Firewall policy port filter": {
"type": "object",
"description": "Defines rules for matching traffic by port.",
"properties": {
"type": {
"type": "string"
},
"matchOpposite": {
"type": "boolean",
"description": "Match on all ports except the specified ones."
}
},
"required": [
"matchOpposite",
"type"
]
},
"Firewall policy region filter": {
"type": "object",
"properties": {
"regions": {
"type": "array",
"description": "Match traffic originating from selected regions. Regions are identified by their ISO 3166-1 alpha-2 country codes.",
"items": {
"type": "string",
"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"
]
},
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"regions"
]
},
"Firewall policy site-to-site VPN tunnel filter": {
"type": "object",
"properties": {
"siteToSiteVpnTunnelId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"siteToSiteVpnTunnelId"
]
},
"Firewall policy source": {
"type": "object",
"properties": {
"zoneId": {
"type": "string",
"format": "uuid",
"description": "ID of the firewall zone from which the matched traffic originates."
},
"trafficFilter": {
"$ref": "#/components/schemas/Firewall policy source traffic filter"
}
},
"required": [
"zoneId"
]
},
"Firewall policy source traffic filter": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Firewall schedule": {
"description": "Defines date and time when the entity is active. If null, the entity is always active.",
"properties": {
"mode": {
"type": "string"
}
},
"required": [
"mode"
],
"type": "object"
},
"Firewall schedule time": {
"type": "object",
"description": "Defines the time range when the entity is active. If null, the entity is active all day.",
"properties": {
"startTime": {
"type": "string",
"description": "Time in HH:MM format. Uses 24-hour clock system. ISO 8601 compliant.",
"example": "21:37"
},
"stopTime": {
"type": "string",
"description": "Time in HH:MM format. Uses 24-hour clock system. ISO 8601 compliant.",
"example": "21:37"
}
},
"required": [
"startTime",
"stopTime"
]
},
"IP matching": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"IntegrationFirewallPolicyActionAllowDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy action"
},
{
"type": "object",
"properties": {
"allowReturnTraffic": {
"type": "boolean",
"description": "Creates a derived policy for the mirrored firewall zone pair to automatically allow the return traffic."
}
},
"required": [
"allowReturnTraffic"
]
}
]
},
"IntegrationFirewallPolicyActionBlockDto": {
"$ref": "#/components/schemas/Firewall policy action"
},
"IntegrationFirewallPolicyActionRejectDto": {
"$ref": "#/components/schemas/Firewall policy action"
},
"IntegrationFirewallPolicyDestinationApplicationCategoryFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"type": "object",
"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."
}
},
"required": [
"applicationCategoryFilter"
]
}
]
},
"IntegrationFirewallPolicyDestinationApplicationFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"type": "object",
"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."
}
},
"required": [
"applicationFilter"
]
}
]
},
"IntegrationFirewallPolicyDestinationDomainFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"type": "object",
"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."
}
},
"required": [
"domainFilter"
]
}
]
},
"IntegrationFirewallPolicyDestinationIpAddressFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"type": "object",
"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."
}
},
"required": [
"ipAddressFilter"
]
}
]
},
"IntegrationFirewallPolicyDestinationIpv6IidFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"type": "object",
"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."
}
},
"required": [
"ipv6IidFilter"
]
}
]
},
"IntegrationFirewallPolicyDestinationNetworkFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"type": "object",
"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."
}
},
"required": [
"networkFilter"
]
}
]
},
"IntegrationFirewallPolicyDestinationPortFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"type": "object",
"properties": {
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic by ports."
}
},
"required": [
"portFilter"
]
}
]
},
"IntegrationFirewallPolicyDestinationRegionFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"type": "object",
"properties": {
"regionFilter": {
"$ref": "#/components/schemas/Firewall policy region filter",
"description": "Match destination traffic by regions."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic additionally by ports. If null, match all ports."
}
},
"required": [
"regionFilter"
]
}
]
},
"IntegrationFirewallPolicyDestinationSiteToSiteVpnTunnelFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"type": "object",
"properties": {
"siteToSiteVpnTunnelFilter": {
"$ref": "#/components/schemas/Firewall policy site-to-site VPN tunnel filter",
"description": "Match destination traffic by site-to-site VPN tunnel."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic additionally by ports. If null, match all ports."
}
},
"required": [
"siteToSiteVpnTunnelFilter"
]
}
]
},
"IntegrationFirewallPolicyDestinationVpnServerFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy destination traffic filter"
},
{
"type": "object",
"properties": {
"vpnServerFilter": {
"$ref": "#/components/schemas/Firewall policy VPN server filter",
"description": "Match destination traffic by VPN servers."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match destination traffic additionally by ports. If null, match all ports."
}
},
"required": [
"vpnServerFilter"
]
}
]
},
"IntegrationFirewallPolicyIpAddressTrafficMatchingListFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IP address filter"
},
{
"type": "object",
"properties": {
"trafficMatchingListId": {
"type": "string",
"format": "uuid",
"description": "ID of Traffic Matching List containing IP addresses to match."
}
},
"required": [
"matchOpposite",
"trafficMatchingListId"
]
}
]
},
"IntegrationFirewallPolicyIpMatchingIpAddressDto": {
"allOf": [
{
"$ref": "#/components/schemas/IP matching"
},
{
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "IP address to match."
}
},
"required": [
"value"
]
}
]
},
"IntegrationFirewallPolicyIpMatchingRangeDto": {
"allOf": [
{
"$ref": "#/components/schemas/IP matching"
},
{
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "First IP address from range to match."
},
"stop": {
"type": "string",
"description": "Last IP address from range to match."
}
},
"required": [
"start",
"stop"
]
}
]
},
"IntegrationFirewallPolicyIpMatchingSubnetDto": {
"allOf": [
{
"$ref": "#/components/schemas/IP matching"
},
{
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "IP subnet in CIDR notation to match."
}
},
"required": [
"value"
]
}
]
},
"IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolDefaultDto": {
"type": "object",
"description": "Defines rules for matching by protocol name.",
"properties": {
"name": {
"type": "string",
"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"
]
}
},
"required": [
"name"
]
},
"IntegrationFirewallPolicyIpv4AndIpv6NamedProtocolFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 protocol"
},
{
"type": "object",
"properties": {
"protocol": {
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 named protocol"
},
"matchOpposite": {
"type": "boolean",
"description": "Match on all protocols except the specified protocol."
}
},
"required": [
"matchOpposite",
"protocol"
]
}
]
},
"IntegrationFirewallPolicyIpv4AndIpv6ProtocolPresetFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 protocol"
},
{
"type": "object",
"properties": {
"preset": {
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 protocol preset"
}
},
"required": [
"preset"
]
}
]
},
"IntegrationFirewallPolicyIpv4AndIpv6ProtocolPresetTcpUdpDto": {
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 protocol preset"
},
"IntegrationFirewallPolicyIpv4AndIpv6ProtocolScopeDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IP protocol scope"
},
{
"type": "object",
"properties": {
"protocolFilter": {
"$ref": "#/components/schemas/Firewall policy IPv4 and IPv6 protocol"
}
}
}
]
},
"IntegrationFirewallPolicyIpv4NamedProtocolDefaultDto": {
"$ref": "#/components/schemas/Firewall policy IPv4 named protocol"
},
"IntegrationFirewallPolicyIpv4NamedProtocolFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 protocol"
},
{
"type": "object",
"properties": {
"protocol": {
"$ref": "#/components/schemas/Firewall policy IPv4 named protocol"
},
"matchOpposite": {
"type": "boolean",
"description": "Match on all protocols except the specified protocol."
}
},
"required": [
"matchOpposite",
"protocol"
]
}
]
},
"IntegrationFirewallPolicyIpv4NamedProtocolIcmpDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 named protocol"
},
{
"type": "object",
"properties": {
"typenameFilter": {
"type": "string",
"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"
]
}
}
}
]
},
"IntegrationFirewallPolicyIpv4ProtocolPresetFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv4 protocol"
},
{
"type": "object",
"properties": {
"preset": {
"$ref": "#/components/schemas/Firewall policy IPv4 protocol preset"
}
},
"required": [
"preset"
]
}
]
},
"IntegrationFirewallPolicyIpv4ProtocolPresetTcpUdpDto": {
"$ref": "#/components/schemas/Firewall policy IPv4 protocol preset"
},
"IntegrationFirewallPolicyIpv4ProtocolScopeDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IP protocol scope"
},
{
"type": "object",
"properties": {
"protocolFilter": {
"$ref": "#/components/schemas/Firewall policy IPv4 protocol"
}
}
}
]
},
"IntegrationFirewallPolicyIpv6NamedProtocolDefaultDto": {
"$ref": "#/components/schemas/Firewall policy IPv6 named protocol"
},
"IntegrationFirewallPolicyIpv6NamedProtocolFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv6 protocol"
},
{
"type": "object",
"properties": {
"protocol": {
"$ref": "#/components/schemas/Firewall policy IPv6 named protocol"
},
"matchOpposite": {
"type": "boolean",
"description": "Match on all protocols except the specified protocol."
}
},
"required": [
"matchOpposite",
"protocol"
]
}
]
},
"IntegrationFirewallPolicyIpv6NamedProtocolIcmpv6Dto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv6 named protocol"
},
{
"type": "object",
"properties": {
"typenameFilter": {
"type": "string",
"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"
]
}
}
}
]
},
"IntegrationFirewallPolicyIpv6ProtocolPresetFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IPv6 protocol"
},
{
"type": "object",
"properties": {
"preset": {
"$ref": "#/components/schemas/Firewall policy IPv6 protocol preset"
}
},
"required": [
"preset"
]
}
]
},
"IntegrationFirewallPolicyIpv6ProtocolPresetTcpUdpDto": {
"$ref": "#/components/schemas/Firewall policy IPv6 protocol preset"
},
"IntegrationFirewallPolicyIpv6ProtocolScopeDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IP protocol scope"
},
{
"type": "object",
"properties": {
"protocolFilter": {
"$ref": "#/components/schemas/Firewall policy IPv6 protocol"
}
}
}
]
},
"IntegrationFirewallPolicyPortReferenceFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy port filter"
},
{
"type": "object",
"properties": {
"trafficMatchingListId": {
"type": "string",
"format": "uuid",
"description": "ID of Traffic Matching List containing ports to match."
}
},
"required": [
"matchOpposite",
"trafficMatchingListId"
]
}
]
},
"IntegrationFirewallPolicyPortValueFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy port filter"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of ports or port ranges to match.",
"items": {
"$ref": "#/components/schemas/Port matching"
},
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"items",
"matchOpposite"
]
}
]
},
"IntegrationFirewallPolicySourceIpAddressFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"type": "object",
"properties": {
"ipAddressFilter": {
"$ref": "#/components/schemas/Firewall policy IP address filter",
"description": "Match source traffic by IP addresses"
},
"macAddressFilter": {
"type": "string",
"description": "Match source traffic additionally by a MAC address. If null, match all MAC addresses."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic additionally by ports. If null, match all ports."
}
},
"required": [
"ipAddressFilter"
]
}
]
},
"IntegrationFirewallPolicySourceIpv6IidFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"type": "object",
"properties": {
"ipv6IidFilter": {
"$ref": "#/components/schemas/Firewall policy IPv6 interface identifier filter",
"description": "Match source traffic by IPv6 interface identifier"
},
"macAddressFilter": {
"type": "string",
"description": "Match source traffic additionally by a MAC address. If null, match all MAC addresses."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic additionally by ports. If null, match all ports."
}
},
"required": [
"ipv6IidFilter"
]
}
]
},
"IntegrationFirewallPolicySourceMacAddressFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"type": "object",
"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."
}
},
"required": [
"macAddressFilter"
]
}
]
},
"IntegrationFirewallPolicySourceNetworkFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"type": "object",
"properties": {
"networkFilter": {
"$ref": "#/components/schemas/Firewall policy network filter",
"description": "Match source traffic by networks."
},
"macAddressFilter": {
"type": "string",
"description": "Match source traffic additionally by a MAC address. If null, match all MAC addresses."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic additionally by ports. If null, match all ports."
}
},
"required": [
"networkFilter"
]
}
]
},
"IntegrationFirewallPolicySourcePortFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"type": "object",
"properties": {
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic by ports."
}
},
"required": [
"portFilter"
]
}
]
},
"IntegrationFirewallPolicySourceRegionFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"type": "object",
"properties": {
"regionFilter": {
"$ref": "#/components/schemas/Firewall policy region filter",
"description": "Match source traffic by regions."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic additionally by ports. If null, match all ports."
}
},
"required": [
"regionFilter"
]
}
]
},
"IntegrationFirewallPolicySourceSiteToSiteVpnTunnelFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"type": "object",
"properties": {
"siteToSiteVpnTunnelFilter": {
"$ref": "#/components/schemas/Firewall policy site-to-site VPN tunnel filter",
"description": "Match source traffic by site-to-site VPN tunnel."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic additionally by ports. If null, match all ports."
}
},
"required": [
"siteToSiteVpnTunnelFilter"
]
}
]
},
"IntegrationFirewallPolicySourceVpnServerFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy source traffic filter"
},
{
"type": "object",
"properties": {
"vpnServerFilter": {
"$ref": "#/components/schemas/Firewall policy VPN server filter",
"description": "Match source traffic by VPN servers."
},
"portFilter": {
"$ref": "#/components/schemas/Firewall policy port filter",
"description": "Match source traffic additionally by ports. If null, match all ports."
}
},
"required": [
"vpnServerFilter"
]
}
]
},
"IntegrationFirewallPolicySpecificDomainFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy domain filter"
},
{
"type": "object",
"properties": {
"domains": {
"type": "array",
"description": "List of domains to match.",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"domains"
]
}
]
},
"IntegrationFirewallPolicySpecificIpAddressFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall policy IP address filter"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of IP addresses, IP address ranges, or IP subnets to match.",
"items": {
"$ref": "#/components/schemas/IP matching"
},
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"items",
"matchOpposite"
]
}
]
},
"IntegrationFirewallScheduleCustomDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall schedule"
},
{
"type": "object",
"properties": {
"timeFilter": {
"$ref": "#/components/schemas/Firewall schedule time"
},
"repeatOnDays": {
"type": "array",
"items": {
"type": "string",
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"minItems": 1,
"uniqueItems": true
},
"startDate": {
"type": "string",
"format": "date",
"description": "Date in YYYY-MM-DD format. ISO 8601 compliant.",
"example": "2025-12-31"
},
"stopDate": {
"type": "string",
"format": "date",
"description": "Date in YYYY-MM-DD format. ISO 8601 compliant.",
"example": "2025-12-31"
}
},
"required": [
"repeatOnDays",
"startDate",
"stopDate"
]
}
]
},
"IntegrationFirewallScheduleEveryDayDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall schedule"
},
{
"type": "object",
"properties": {
"timeFilter": {
"$ref": "#/components/schemas/Firewall schedule time"
}
},
"required": [
"timeFilter"
]
}
]
},
"IntegrationFirewallScheduleEveryWeekDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall schedule"
},
{
"type": "object",
"properties": {
"timeFilter": {
"$ref": "#/components/schemas/Firewall schedule time"
},
"repeatOnDays": {
"type": "array",
"items": {
"type": "string",
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"repeatOnDays"
]
}
]
},
"IntegrationFirewallScheduleOneTimeOnlyDto": {
"allOf": [
{
"$ref": "#/components/schemas/Firewall schedule"
},
{
"type": "object",
"properties": {
"timeFilter": {
"$ref": "#/components/schemas/Firewall schedule time"
},
"date": {
"type": "string",
"format": "date",
"description": "Date in YYYY-MM-DD format. ISO 8601 compliant.",
"example": "2025-12-31"
}
},
"required": [
"date",
"timeFilter"
]
}
]
},
"Firewall policy": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string",
"example": "My firewall policy"
},
"description": {
"type": "string",
"example": "A description for my firewall policy"
},
"index": {
"type": "integer",
"format": "int32"
},
"action": {
"$ref": "#/components/schemas/Firewall policy action"
},
"source": {
"$ref": "#/components/schemas/Firewall policy source"
},
"destination": {
"$ref": "#/components/schemas/Firewall policy destination"
},
"ipProtocolScope": {
"$ref": "#/components/schemas/Firewall policy IP protocol scope"
},
"connectionStateFilter": {
"type": "array",
"description": "Match on firewall connection state. If null, matches all connection states.",
"items": {
"type": "string",
"enum": [
"NEW",
"INVALID",
"ESTABLISHED",
"RELATED"
]
},
"maxItems": 2147483647,
"minItems": 1,
"uniqueItems": true
},
"ipsecFilter": {
"type": "string",
"description": "Match on traffic encrypted, or not encrypted by IPsec. If null, matches all traffic.",
"enum": [
"MATCH_ENCRYPTED",
"MATCH_NOT_ENCRYPTED"
]
},
"loggingEnabled": {
"type": "boolean",
"description": "Generate syslog entries when traffic is matched. Such entries are sent to a remote syslog server."
},
"schedule": {
"$ref": "#/components/schemas/Firewall schedule"
},
"metadata": {
"$ref": "#/components/schemas/User or system defined or derived entity metadata"
}
},
"required": [
"action",
"destination",
"enabled",
"id",
"index",
"ipProtocolScope",
"loggingEnabled",
"metadata",
"name",
"source"
]
},
"User or system defined or derived entity metadata": {
"properties": {
"origin": {
"type": "string"
}
},
"required": [
"origin"
],
"type": "object"
},
"IntegrationFirewallPolicyOrderingDto": {
"type": "object",
"properties": {
"orderedFirewallPolicyIds": {
"$ref": "#/components/schemas/Ordered firewall policy IDs"
}
},
"required": [
"orderedFirewallPolicyIds"
]
},
"Ordered firewall policy IDs": {
"type": "object",
"properties": {
"beforeSystemDefined": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"afterSystemDefined": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"required": [
"afterSystemDefined",
"beforeSystemDefined"
]
},
"Create or update DNS policy": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"type"
]
},
"IntegrationDnsARecordCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"ipv4Address": {
"type": "string",
"example": "192.168.1.10"
},
"ttlSeconds": {
"type": "integer",
"format": "int32",
"description": "Time to live in seconds.",
"example": 14400,
"maximum": 86400,
"minimum": 0
}
},
"required": [
"domain",
"enabled",
"ipv4Address",
"ttlSeconds"
]
}
]
},
"IntegrationDnsAaaaRecordCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"ipv6Address": {
"type": "string",
"example": "cafe::babe"
},
"ttlSeconds": {
"type": "integer",
"format": "int32",
"description": "Time to live in seconds.",
"example": 14400,
"maximum": 86400,
"minimum": 0
}
},
"required": [
"domain",
"enabled",
"ipv6Address",
"ttlSeconds"
]
}
]
},
"IntegrationDnsCnameRecordCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"targetDomain": {
"type": "string",
"example": "target.example.com",
"maxLength": 127,
"minLength": 1
},
"ttlSeconds": {
"type": "integer",
"format": "int32",
"description": "Time to live in seconds.",
"example": 14400,
"maximum": 604800,
"minimum": 0
}
},
"required": [
"domain",
"enabled",
"targetDomain",
"ttlSeconds"
]
}
]
},
"IntegrationDnsForwardDomainPolicyCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"ipAddress": {
"type": "string",
"description": "IP address of the DNS Server that the DNS query is forwarded to.",
"example": "8.8.4.4|2001:4860:4860::8844"
}
},
"required": [
"domain",
"enabled",
"ipAddress"
]
}
]
},
"IntegrationDnsMxRecordCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"mailServerDomain": {
"type": "string",
"example": "mail.example.com",
"maxLength": 127,
"minLength": 1
},
"priority": {
"type": "integer",
"format": "int32",
"description": "Priority. A lower number is preferred.",
"example": 255,
"maximum": 65535,
"minimum": 0
}
},
"required": [
"domain",
"enabled",
"mailServerDomain",
"priority"
]
}
]
},
"IntegrationDnsSrvRecordCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"serverDomain": {
"type": "string",
"description": "Domain of the server that is running the service.",
"example": "server.example.com",
"maxLength": 127,
"minLength": 1
},
"service": {
"type": "string",
"description": "Service associated with this SRV record.",
"example": "_ldap"
},
"protocol": {
"type": "string",
"description": "Protocol used by the service.",
"example": "_tcp"
},
"port": {
"type": "integer",
"format": "int32",
"maximum": 65535,
"minimum": 0
},
"priority": {
"type": "integer",
"format": "int32",
"description": "Priority. A lower number is preferred.",
"example": 255,
"maximum": 65535,
"minimum": 0
},
"weight": {
"type": "integer",
"format": "int32",
"description": "Weight. A relative value applicable for records with the same priority. A lower number is preferred.",
"example": 128,
"maximum": 65535,
"minimum": 0
}
},
"required": [
"domain",
"enabled",
"port",
"priority",
"protocol",
"serverDomain",
"service",
"weight"
]
}
]
},
"IntegrationDnsTxtRecordCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/Create or update DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"text": {
"type": "string",
"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
}
},
"required": [
"domain",
"enabled",
"text"
]
}
]
},
"DNS policy": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"enabled": {
"type": "boolean"
},
"metadata": {
"$ref": "#/components/schemas/User defined entity metadata"
},
"domain": {
"type": "string"
}
},
"required": [
"enabled",
"id",
"metadata",
"type"
]
},
"IntegrationDnsARecordDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"ipv4Address": {
"type": "string",
"example": "192.168.1.10"
},
"ttlSeconds": {
"type": "integer",
"format": "int32",
"description": "Time to live in seconds.",
"example": 14400,
"maximum": 86400,
"minimum": 0
}
},
"required": [
"domain",
"enabled",
"id",
"ipv4Address",
"metadata",
"ttlSeconds"
]
}
]
},
"IntegrationDnsAaaaRecordDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"ipv6Address": {
"type": "string",
"example": "cafe::babe"
},
"ttlSeconds": {
"type": "integer",
"format": "int32",
"description": "Time to live in seconds.",
"example": 14400,
"maximum": 86400,
"minimum": 0
}
},
"required": [
"domain",
"enabled",
"id",
"ipv6Address",
"metadata",
"ttlSeconds"
]
}
]
},
"IntegrationDnsCnameRecordDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"targetDomain": {
"type": "string",
"example": "target.example.com",
"maxLength": 127,
"minLength": 1
},
"ttlSeconds": {
"type": "integer",
"format": "int32",
"description": "Time to live in seconds.",
"example": 14400,
"maximum": 604800,
"minimum": 0
}
},
"required": [
"domain",
"enabled",
"id",
"metadata",
"targetDomain",
"ttlSeconds"
]
}
]
},
"IntegrationDnsForwardDomainPolicyDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"ipAddress": {
"type": "string",
"description": "IP address of the DNS Server that the DNS query is forwarded to.",
"example": "8.8.4.4|2001:4860:4860::8844"
}
},
"required": [
"domain",
"enabled",
"id",
"ipAddress",
"metadata"
]
}
]
},
"IntegrationDnsMxRecordDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"mailServerDomain": {
"type": "string",
"example": "mail.example.com",
"maxLength": 127,
"minLength": 1
},
"priority": {
"type": "integer",
"format": "int32",
"description": "Priority. A lower number is preferred.",
"example": 255,
"maximum": 65535,
"minimum": 0
}
},
"required": [
"domain",
"enabled",
"id",
"mailServerDomain",
"metadata",
"priority"
]
}
]
},
"IntegrationDnsSrvRecordDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"serverDomain": {
"type": "string",
"description": "Domain of the server that is running the service.",
"example": "server.example.com",
"maxLength": 127,
"minLength": 1
},
"service": {
"type": "string",
"description": "Service associated with this SRV record.",
"example": "_ldap"
},
"protocol": {
"type": "string",
"description": "Protocol used by the service.",
"example": "_tcp"
},
"port": {
"type": "integer",
"format": "int32",
"maximum": 65535,
"minimum": 0
},
"priority": {
"type": "integer",
"format": "int32",
"description": "Priority. A lower number is preferred.",
"example": 255,
"maximum": 65535,
"minimum": 0
},
"weight": {
"type": "integer",
"format": "int32",
"description": "Weight. A relative value applicable for records with the same priority. A lower number is preferred.",
"example": 128,
"maximum": 65535,
"minimum": 0
}
},
"required": [
"domain",
"enabled",
"id",
"metadata",
"port",
"priority",
"protocol",
"serverDomain",
"service",
"weight"
]
}
]
},
"IntegrationDnsTxtRecordDto": {
"allOf": [
{
"$ref": "#/components/schemas/DNS policy"
},
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 127,
"minLength": 1
},
"text": {
"type": "string",
"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
}
},
"required": [
"domain",
"enabled",
"id",
"metadata",
"text"
]
}
]
},
"ACL rule device filter": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ACL rule update": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"enabled": {
"type": "boolean",
"example": true
},
"name": {
"type": "string",
"description": "ACL rule name",
"minLength": 1
},
"description": {
"type": "string",
"description": "ACL rule description"
},
"action": {
"type": "string",
"description": "ACL rule action",
"enum": [
"ALLOW",
"BLOCK"
],
"example": "ALLOW|BLOCK"
},
"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": {
"type": "integer",
"format": "int32",
"deprecated": true,
"description": "ACL rule index. This property is deprecated and has no effect. Use the dedicated ACL rule reordering endpoint.",
"minimum": 0
},
"sourceFilter": {
"description": "Traffic source filter"
},
"destinationFilter": {
"description": "Traffic destination filter"
}
},
"required": [
"action",
"enabled",
"name",
"type"
]
},
"IP ACL rule endpoint": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"IntegrationAclRuleDevicesFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/ACL rule device filter"
},
{
"type": "object",
"properties": {
"deviceIds": {
"type": "array",
"description": "List of Switch capable device IDs to which the ACL rule will be provisioned.",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"deviceIds"
]
}
]
},
"IntegrationIpAclRuleCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/ACL rule update"
},
{
"type": "object",
"properties": {
"sourceFilter": {
"$ref": "#/components/schemas/IP ACL rule endpoint",
"description": "Traffic source filter"
},
"destinationFilter": {
"$ref": "#/components/schemas/IP ACL rule endpoint",
"description": "Traffic destination filter"
},
"protocolFilter": {
"type": "array",
"description": "Protocols this ACL rule will be applied to. When null, the rule will be applied to all protocols.",
"items": {
"type": "string",
"enum": [
"TCP",
"UDP"
]
},
"maxItems": 2147483647,
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"action",
"enabled",
"name"
]
}
]
},
"IntegrationIpAclRuleNetworkEndpointFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/IP ACL rule endpoint"
},
{
"type": "object",
"properties": {
"networkIds": {
"type": "array",
"description": "Network IDs",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1,
"uniqueItems": true
},
"portFilter": {
"type": "array",
"description": "Ports this ACL rule will be applied to. If null, the rule will be applied to all ports.",
"items": {
"type": "integer",
"format": "int32",
"maximum": 65535,
"minimum": 1
},
"maxItems": 2147483647,
"maximum": 65535,
"minItems": 1,
"minimum": 1,
"uniqueItems": true
}
},
"required": [
"networkIds"
]
}
]
},
"IntegrationIpAclRulePortEndpointFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/IP ACL rule endpoint"
},
{
"type": "object",
"properties": {
"portFilter": {
"type": "array",
"description": "Ports this ACL rule will be applied to.",
"items": {
"type": "integer",
"format": "int32",
"maximum": 65535,
"minimum": 1
},
"maximum": 65535,
"minItems": 1,
"minimum": 1,
"uniqueItems": true
}
},
"required": [
"portFilter"
]
}
]
},
"IntegrationIpAclRuleSubnetEndpointFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/IP ACL rule endpoint"
},
{
"type": "object",
"properties": {
"ipAddressesOrSubnets": {
"type": "array",
"description": "IP addresses or subnets",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
},
"portFilter": {
"type": "array",
"description": "Ports this ACL rule will be applied to. If null, all the rule will be applied to all ports.",
"items": {
"type": "integer",
"format": "int32",
"maximum": 65535,
"minimum": 1
},
"maxItems": 2147483647,
"maximum": 65535,
"minItems": 1,
"minimum": 1,
"uniqueItems": true
}
},
"required": [
"ipAddressesOrSubnets"
]
}
]
},
"IntegrationMacAclRuleCreateUpdateDto": {
"allOf": [
{
"$ref": "#/components/schemas/ACL rule update"
},
{
"type": "object",
"properties": {
"sourceFilter": {
"$ref": "#/components/schemas/MAC ACL rule endpoint",
"description": "Traffic source filter"
},
"destinationFilter": {
"$ref": "#/components/schemas/MAC ACL rule endpoint",
"description": "Traffic destination filter"
},
"networkIdFilter": {
"type": "string",
"format": "uuid",
"description": "Network ID to which this ACL rule applies"
}
},
"required": [
"action",
"enabled",
"name",
"networkIdFilter"
]
}
]
},
"IntegrationMacAclRuleMacAddressEndpointFilterDto": {
"allOf": [
{
"$ref": "#/components/schemas/MAC ACL rule endpoint"
},
{
"type": "object",
"properties": {
"macAddresses": {
"type": "array",
"description": "Source/destination MAC addresses this ACL rule will apply to.",
"items": {
"type": "string"
},
"minItems": 1
},
"prefixLength": {
"type": "integer",
"format": "int32",
"description": "MAC address prefix length. When null, full MAC address(-es) will be used.",
"maximum": 48,
"minimum": 1
}
},
"required": [
"macAddresses"
]
}
]
},
"MAC ACL rule endpoint": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ACL rule": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"enabled": {
"type": "boolean",
"example": true
},
"name": {
"type": "string",
"description": "ACL rule name",
"minLength": 1
},
"description": {
"type": "string",
"description": "ACL rule description"
},
"action": {
"type": "string",
"description": "ACL rule action",
"enum": [
"ALLOW",
"BLOCK"
],
"example": "ALLOW|BLOCK"
},
"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": {
"type": "integer",
"format": "int32",
"description": "ACL rule index. Lower index has higher priority",
"minimum": 0
},
"sourceFilter": {
"description": "Traffic source filter"
},
"destinationFilter": {
"description": "Traffic destination filter"
},
"metadata": {
"$ref": "#/components/schemas/User defined or derived entity metadata",
"description": "Only user-defined rules can be deleted or modified"
}
},
"required": [
"action",
"enabled",
"id",
"index",
"metadata",
"name",
"type"
]
},
"IntegrationIpAclRuleDto": {
"allOf": [
{
"$ref": "#/components/schemas/ACL rule"
},
{
"type": "object",
"properties": {
"sourceFilter": {
"$ref": "#/components/schemas/IP ACL rule endpoint",
"description": "Traffic source filter"
},
"destinationFilter": {
"$ref": "#/components/schemas/IP ACL rule endpoint",
"description": "Traffic destination filter"
},
"protocolFilter": {
"type": "array",
"description": "Protocols this ACL rule will be applied to. When null, the rule will be applied to all protocols.",
"items": {
"type": "string",
"enum": [
"TCP",
"UDP"
]
},
"maxItems": 2147483647,
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"action",
"enabled",
"id",
"index",
"metadata",
"name"
]
},
{
"$ref": "#/components/schemas/ACL ruleObject"
}
]
},
"IntegrationMacAclRuleDto": {
"allOf": [
{
"$ref": "#/components/schemas/ACL rule"
},
{
"type": "object",
"properties": {
"sourceFilter": {
"$ref": "#/components/schemas/MAC ACL rule endpoint",
"description": "Traffic source filter"
},
"destinationFilter": {
"$ref": "#/components/schemas/MAC ACL rule endpoint",
"description": "Traffic destination filter"
},
"networkIdFilter": {
"type": "string",
"format": "uuid",
"description": "Network ID to which this ACL rule applies"
}
},
"required": [
"action",
"enabled",
"id",
"index",
"metadata",
"name",
"networkIdFilter"
]
},
{
"$ref": "#/components/schemas/ACL ruleObject"
}
]
},
"ACL rule ordering": {
"type": "object",
"properties": {
"orderedAclRuleIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"required": [
"orderedAclRuleIds"
]
},
"Hotspot voucher creation request": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32",
"default": 1,
"description": "Number of vouchers to generate",
"maximum": 1000,
"minimum": 1
},
"name": {
"type": "string",
"description": "Voucher note, duplicated across all generated vouchers",
"minLength": 1
},
"authorizedGuestLimit": {
"type": "integer",
"format": "int64",
"description": "(Optional) limit for how many different guests can use the same voucher to authorize network access",
"example": 1,
"minimum": 1
},
"timeLimitMinutes": {
"type": "integer",
"format": "int64",
"description": "How long (in minutes) the voucher will provide access to the network since authorization of the first guest.\nSubsequently connected guests, if allowed, will share the same expiration time.",
"maximum": 1000000,
"minimum": 1
},
"dataUsageLimitMBytes": {
"type": "integer",
"format": "int64",
"description": "(Optional) data usage limit in megabytes",
"maximum": 1048576,
"minimum": 1
},
"rxRateLimitKbps": {
"type": "integer",
"format": "int64",
"description": "(Optional) download rate limit in kilobits per second",
"maximum": 100000,
"minimum": 2
},
"txRateLimitKbps": {
"type": "integer",
"format": "int64",
"description": "(Optional) upload rate limit in kilobits per second",
"maximum": 100000,
"minimum": 2
}
},
"required": [
"name",
"timeLimitMinutes"
]
},
"Hotspot voucher details": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string",
"description": "Voucher note, may contain duplicate values across multiple vouchers",
"example": "hotel-guest"
},
"code": {
"type": "string",
"description": "Secret code to active the voucher using the Hotspot portal",
"example": 4861409510
},
"authorizedGuestLimit": {
"type": "integer",
"format": "int64",
"description": "(Optional) limit for how many different guests can use the same voucher to authorize network access",
"example": 1
},
"authorizedGuestCount": {
"type": "integer",
"format": "int64",
"description": "For how many guests the voucher has been used to authorize network access",
"example": 0
},
"activatedAt": {
"type": "string",
"format": "date-time",
"description": "(Optional) timestamp when the voucher has been activated (authorization time of the first guest)"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "(Optional) timestamp when the voucher will become expired. All guests using the voucher will be unauthorized from network access"
},
"expired": {
"type": "boolean",
"description": "Whether the voucher has been expired and can no longer be used to authorize network access"
},
"timeLimitMinutes": {
"type": "integer",
"format": "int64",
"description": "How long (in minutes) the voucher will provide access to the network since authorization of the first guest.\nSubsequently connected guests, if allowed, will share the same expiration time.",
"example": 1440
},
"dataUsageLimitMBytes": {
"type": "integer",
"format": "int64",
"description": "(Optional) data usage limit in megabytes",
"example": 1024
},
"rxRateLimitKbps": {
"type": "integer",
"format": "int64",
"description": "(Optional) download rate limit in kilobits per second",
"example": 1000
},
"txRateLimitKbps": {
"type": "integer",
"format": "int64",
"description": "(Optional) upload rate limit in kilobits per second",
"example": 1000
}
},
"required": [
"authorizedGuestCount",
"code",
"createdAt",
"expired",
"id",
"name",
"timeLimitMinutes"
]
},
"IntegrationVoucherCreationResultDto": {
"type": "object",
"properties": {
"vouchers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Hotspot voucher details"
}
}
}
},
"IntegrationDeviceAdoptionRequestDto": {
"type": "object",
"properties": {
"macAddress": {
"type": "string"
},
"ignoreDeviceLimit": {
"type": "boolean"
}
},
"required": [
"ignoreDeviceLimit",
"macAddress"
]
},
"Access point feature overview": {
"type": "object",
"description": "Access point feature overview"
},
"Adopted device details": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"macAddress": {
"type": "string",
"example": "94:2a:6f:26:c6:ca"
},
"ipAddress": {
"type": "string",
"example": "192.168.1.55"
},
"name": {
"type": "string",
"example": "IW HD"
},
"model": {
"type": "string",
"example": "UHDIW"
},
"supported": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"ONLINE",
"OFFLINE",
"PENDING_ADOPTION",
"UPDATING",
"GETTING_READY",
"ADOPTING",
"DELETING",
"CONNECTION_INTERRUPTED",
"ISOLATED",
"U5G_INCORRECT_TOPOLOGY"
]
},
"firmwareVersion": {
"type": "string",
"example": "6.6.55"
},
"firmwareUpdatable": {
"type": "boolean"
},
"adoptedAt": {
"type": "string",
"format": "date-time"
},
"provisionedAt": {
"type": "string",
"format": "date-time"
},
"configurationId": {
"type": "string",
"example": "7596498d2f367dc2"
},
"uplink": {
"$ref": "#/components/schemas/Device uplink interface overview"
},
"features": {
"$ref": "#/components/schemas/Device features"
},
"interfaces": {
"$ref": "#/components/schemas/Device physical interfaces"
}
},
"required": [
"configurationId",
"features",
"firmwareUpdatable",
"id",
"interfaces",
"ipAddress",
"macAddress",
"model",
"name",
"state",
"supported"
]
},
"Device features": {
"type": "object",
"properties": {
"switching": {
"$ref": "#/components/schemas/Switch feature overview",
"example": {}
},
"accessPoint": {
"$ref": "#/components/schemas/Access point feature overview",
"example": {}
}
}
},
"Device physical interfaces": {
"type": "object",
"properties": {
"ports": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Port overview"
}
},
"radios": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Wireless radio overview"
}
}
}
},
"Device uplink interface overview": {
"type": "object",
"description": "Uplink interface is device's connection to the parent device in the network topology",
"properties": {
"deviceId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"deviceId"
]
},
"Port PoE overview": {
"type": "object",
"properties": {
"standard": {
"type": "string",
"enum": [
"802.3af",
"802.3at",
"802.3bt"
],
"example": "802.3bt"
},
"type": {
"type": "integer",
"format": "int32",
"enum": [
"1",
"2",
"3",
"4"
],
"example": 3
},
"enabled": {
"type": "boolean",
"description": "Whether the PoE feature is enabled on the port"
},
"state": {
"type": "string",
"description": "Whether the port currently supplies power to the (connected) device.",
"enum": [
"UP",
"DOWN",
"LIMITED",
"UNKNOWN"
]
}
},
"required": [
"enabled",
"standard",
"state",
"type"
]
},
"Port overview": {
"type": "object",
"properties": {
"idx": {
"type": "integer",
"format": "int32",
"example": 1,
"minimum": 1
},
"state": {
"type": "string",
"enum": [
"UP",
"DOWN",
"UNKNOWN"
]
},
"connector": {
"type": "string",
"enum": [
"RJ45",
"SFP",
"SFPPLUS",
"SFP28",
"QSFP28"
]
},
"maxSpeedMbps": {
"type": "integer",
"format": "int32",
"example": 10000
},
"speedMbps": {
"type": "integer",
"format": "int32",
"example": 1000
},
"poe": {
"$ref": "#/components/schemas/Port PoE overview"
}
},
"required": [
"connector",
"idx",
"maxSpeedMbps",
"state"
]
},
"Switch feature overview": {
"type": "object",
"description": "Switch feature overview"
},
"Wireless radio overview": {
"type": "object",
"properties": {
"wlanStandard": {
"type": "string",
"enum": [
"802.11a",
"802.11b",
"802.11g",
"802.11n",
"802.11ac",
"802.11ax",
"802.11be"
]
},
"frequencyGHz": {
"type": "number",
"enum": [
2.4,
5.0,
6.0,
60.0
]
},
"channelWidthMHz": {
"type": "integer",
"format": "int32",
"example": 40
},
"channel": {
"type": "integer",
"format": "int32",
"example": 36
}
},
"required": [
"channelWidthMHz",
"frequencyGHz",
"wlanStandard"
]
},
"Port PoE power-cycle request": {
"$ref": "#/components/schemas/Port action request"
},
"Port action request": {
"properties": {
"action": {
"type": "string"
}
},
"required": [
"action"
],
"type": "object"
},
"Device action request": {
"properties": {
"action": {
"type": "string"
}
},
"required": [
"action"
],
"type": "object"
},
"Device restart request": {
"$ref": "#/components/schemas/Device action request"
},
"Client action request": {
"properties": {
"action": {
"type": "string"
}
},
"required": [
"action"
],
"type": "object"
},
"Guest access authorization request": {
"allOf": [
{
"$ref": "#/components/schemas/Client action request"
},
{
"type": "object",
"properties": {
"timeLimitMinutes": {
"type": "integer",
"format": "int64",
"description": "(Optional) how long (in minutes) the guest will be authorized to access the network.\nIf not specified, the default limit is used from the site settings",
"maximum": 1000000,
"minimum": 1
},
"dataUsageLimitMBytes": {
"type": "integer",
"format": "int64",
"description": "(Optional) data usage limit in megabytes",
"maximum": 1048576,
"minimum": 1
},
"rxRateLimitKbps": {
"type": "integer",
"format": "int64",
"description": "(Optional) download rate limit in kilobits per second",
"maximum": 100000,
"minimum": 2
},
"txRateLimitKbps": {
"type": "integer",
"format": "int64",
"description": "(Optional) upload rate limit in kilobits per second",
"maximum": 100000,
"minimum": 2
}
}
}
],
"description": "Authorizes network access to a guest client. Client must be a guest.\nThis action cancels existing active authorization (if exists), creates a new one with new limits\nand resets guest traffic counters."
},
"Guest access unauthorization request": {
"properties": {
"action": {
"type": "string"
}
},
"required": [
"action"
],
"type": "object",
"description": "Unauthorizes network access and disconnects a guest client."
},
"Client action response": {
"properties": {
"action": {
"type": "string"
}
},
"required": [
"action"
],
"type": "object"
},
"Guest access authorization response": {
"allOf": [
{
"$ref": "#/components/schemas/Client action response"
},
{
"type": "object",
"properties": {
"revokedAuthorization": {
"$ref": "#/components/schemas/Guest authorization details",
"description": "(Optional) Revoked authorization in case the guest was already authorized at the time of this request"
},
"grantedAuthorization": {
"$ref": "#/components/schemas/Guest authorization details",
"description": "Granted guest authorization"
}
},
"required": [
"grantedAuthorization"
]
}
]
},
"Guest access unauthorization response": {
"allOf": [
{
"$ref": "#/components/schemas/Client action response"
},
{
"type": "object",
"properties": {
"revokedAuthorization": {
"$ref": "#/components/schemas/Guest authorization details",
"description": "Revoked guest authorization"
}
},
"required": [
"revokedAuthorization"
]
}
]
},
"Guest authorization details": {
"type": "object",
"properties": {
"authorizedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the guest has been authorized"
},
"authorizationMethod": {
"type": "string",
"description": "Guest authorization method (API, Voucher etc)",
"enum": [
"VOUCHER",
"API",
"OTHER"
]
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the guest will get automatically unauthorized"
},
"dataUsageLimitMBytes": {
"type": "integer",
"format": "int64",
"description": "(Optional) data usage limit in megabytes",
"example": 1024
},
"rxRateLimitKbps": {
"type": "integer",
"format": "int64",
"description": "(Optional) download rate limit in kilobits per second",
"example": 1000
},
"txRateLimitKbps": {
"type": "integer",
"format": "int64",
"description": "(Optional) upload rate limit in kilobits per second",
"example": 1000
},
"usage": {
"$ref": "#/components/schemas/Guest authorization usage details"
}
},
"required": [
"authorizationMethod",
"authorizedAt",
"expiresAt"
]
},
"Guest authorization usage details": {
"type": "object",
"properties": {
"durationSec": {
"type": "integer",
"format": "int64"
},
"rxBytes": {
"type": "integer",
"format": "int64"
},
"txBytes": {
"type": "integer",
"format": "int64"
},
"bytes": {
"type": "integer",
"format": "int64"
}
},
"required": [
"bytes",
"durationSec",
"rxBytes",
"txBytes"
]
},
"Patch firewall policy": {
"type": "object",
"properties": {
"loggingEnabled": {
"type": "boolean"
}
}
},
"Site overview": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"internalReference": {
"type": "string",
"description": "Internal unique name of the site used in older APIs"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"internalReference",
"name"
]
},
"Site overview page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Site overview"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"IntegrationIotOptimizedWifiBroadcastOverviewDto": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"metadata": {
"$ref": "#/components/schemas/User or derived or orchestrated entity metadata"
},
"network": {
"$ref": "#/components/schemas/Wifi network reference"
},
"securityConfiguration": {
"$ref": "#/components/schemas/Wifi security configuration overview"
},
"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."
}
},
"required": [
"enabled",
"id",
"metadata",
"name",
"securityConfiguration",
"type"
]
},
"IntegrationStandardWifiBroadcastOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi broadcast overview"
},
{
"type": "object",
"properties": {
"broadcastingFrequenciesGHz": {
"type": "array",
"items": {
"type": "number",
"enum": [
2.4,
5.0,
6.0
]
},
"maxItems": 2147483647,
"minItems": 1,
"uniqueItems": true
},
"hotspotConfiguration": {
"$ref": "#/components/schemas/IntegrationWifiHotspotConfigurationOverviewDto"
}
},
"required": [
"broadcastingFrequenciesGHz",
"enabled",
"id",
"metadata",
"name",
"securityConfiguration"
]
}
]
},
"IntegrationWifiBroadcastPageDto": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Wifi broadcast overview"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"IntegrationWifiHotspotConfigurationOverviewDto": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"CAPTIVE_PORTAL",
"PASSPOINT"
]
}
},
"required": [
"type"
]
},
"IntegrationWifiOpenSecurityConfigurationOverviewDto": {
"$ref": "#/components/schemas/Wifi security configuration overview"
},
"IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto": {
"$ref": "#/components/schemas/Wifi security configuration overview"
},
"IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto": {
"allOf": [
{
"$ref": "#/components/schemas/Wifi security configuration overview"
},
{
"type": "object",
"properties": {
"presharedKeyNetworkIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Wifi network reference"
}
}
}
}
]
},
"IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto": {
"$ref": "#/components/schemas/Wifi security configuration overview"
},
"IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto": {
"$ref": "#/components/schemas/Wifi security configuration overview"
},
"IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto": {
"$ref": "#/components/schemas/Wifi security configuration overview"
},
"IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto": {
"$ref": "#/components/schemas/Wifi security configuration overview"
},
"Wifi broadcast overview": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"metadata": {
"$ref": "#/components/schemas/User or derived or orchestrated entity metadata"
},
"network": {
"$ref": "#/components/schemas/Wifi network reference"
},
"securityConfiguration": {
"$ref": "#/components/schemas/Wifi security configuration overview"
},
"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."
}
},
"required": [
"enabled",
"id",
"metadata",
"name",
"securityConfiguration",
"type"
]
},
"Wifi security configuration overview": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"WAN overview": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"example": "Internet 1"
}
},
"required": [
"id",
"name"
]
},
"WAN overview page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WAN overview"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"IntegrationSiteToSiteIpsecTunnelOverviewDto": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Site-to-site VPN tunnel metadata"
}
},
"required": [
"id",
"metadata",
"name",
"type"
]
},
"IntegrationSiteToSiteOpenVpnTunnelOverviewDto": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Site-to-site VPN tunnel metadata"
}
},
"required": [
"id",
"metadata",
"name",
"type"
]
},
"IntegrationSiteToSiteVpnTunnelOverviewPageDto": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Site-to-site VPN tunnel overview"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"IntegrationSiteToSiteWireguardTunnelOverviewDto": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Site-to-site VPN tunnel metadata"
}
},
"required": [
"id",
"metadata",
"name",
"type"
]
},
"Site-to-site VPN tunnel overview": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Site-to-site VPN tunnel metadata"
}
},
"required": [
"id",
"metadata",
"name",
"type"
]
},
"IntegrationL2tpServerOverviewDto": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"metadata": {
"$ref": "#/components/schemas/User defined or derived entity metadata"
}
},
"required": [
"enabled",
"id",
"metadata",
"name",
"type"
]
},
"IntegrationOpenVpnServerOverviewDto": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"metadata": {
"$ref": "#/components/schemas/User defined or derived entity metadata"
}
},
"required": [
"enabled",
"id",
"metadata",
"name",
"type"
]
},
"IntegrationPptpServerOverviewDto": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"metadata": {
"$ref": "#/components/schemas/User defined or derived entity metadata"
}
},
"required": [
"enabled",
"id",
"metadata",
"name",
"type"
]
},
"IntegrationUidVpnServerOverviewDto": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"metadata": {
"$ref": "#/components/schemas/User defined or derived entity metadata"
}
},
"required": [
"enabled",
"id",
"metadata",
"name",
"type"
]
},
"IntegrationVpnServerOverviewPageDto": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VPN server overview"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"IntegrationWireguardServerOverviewDto": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"metadata": {
"$ref": "#/components/schemas/User defined or derived entity metadata"
}
},
"required": [
"enabled",
"id",
"metadata",
"name",
"type"
]
},
"VPN server overview": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"metadata": {
"$ref": "#/components/schemas/User defined or derived entity metadata"
}
},
"required": [
"enabled",
"id",
"metadata",
"name",
"type"
]
},
"Traffic matching lists page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Traffic matching list"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"Radius Profile Overview": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1
},
"metadata": {
"$ref": "#/components/schemas/User or system defined or derived entity metadata"
}
},
"required": [
"id",
"metadata",
"name"
]
},
"Radius Profile Overview Page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Radius Profile Overview"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"Gateway managed network overview": {
"allOf": [
{
"$ref": "#/components/schemas/Network overview"
},
{
"type": "object",
"properties": {
"zoneId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"default",
"enabled",
"id",
"metadata",
"name",
"vlanId"
]
}
]
},
"Network overview": {
"type": "object",
"properties": {
"management": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"example": "Default Network"
},
"enabled": {
"type": "boolean"
},
"vlanId": {
"type": "integer",
"format": "int32",
"description": "VLAN ID. Must be 1 for the default network and >= 2 for additional networks.",
"maximum": 4009,
"minimum": 1
},
"metadata": {
"$ref": "#/components/schemas/User or system defined or orchestrated entity metadata",
"description": "Orchestrated or System-defined configurable network support"
},
"default": {
"type": "boolean"
}
},
"required": [
"default",
"enabled",
"id",
"management",
"metadata",
"name",
"vlanId"
]
},
"Network overview page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Network overview"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"Switch managed network overview": {
"allOf": [
{
"$ref": "#/components/schemas/Network overview"
},
{
"type": "object",
"properties": {
"deviceId": {
"type": "string",
"format": "uuid",
"description": "ID of the switch this Network is managed by.",
"example": "550e8400-e29b-41d4-a716-446655440000"
}
},
"required": [
"default",
"deviceId",
"enabled",
"id",
"metadata",
"name",
"vlanId"
]
}
]
},
"Unmanaged network overview": {
"type": "object",
"properties": {
"management": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"example": "Default Network"
},
"enabled": {
"type": "boolean"
},
"vlanId": {
"type": "integer",
"format": "int32",
"description": "VLAN ID. Must be 1 for the default network and >= 2 for additional networks.",
"maximum": 4009,
"minimum": 1
},
"metadata": {
"$ref": "#/components/schemas/User or system defined or orchestrated entity metadata",
"description": "Orchestrated or System-defined configurable network support"
},
"default": {
"type": "boolean"
}
},
"required": [
"default",
"enabled",
"id",
"management",
"metadata",
"name",
"vlanId"
]
},
"Network reference detail": {
"type": "object",
"properties": {
"referenceId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"referenceId"
]
},
"Network reference resource": {
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"enum": [
"CLIENT",
"DEVICE",
"STATIC_ROUTE",
"OSPF_ROUTE",
"NEXT_AI",
"WIFI",
"NAT_RULE",
"SD_WAN"
]
},
"referenceCount": {
"type": "integer",
"format": "int32",
"description": "Number of references of this type",
"minimum": 1
},
"references": {
"type": "array",
"description": "List of references, present only if resourceType has API model defined",
"items": {
"$ref": "#/components/schemas/Network reference detail"
}
}
},
"required": [
"referenceCount",
"resourceType"
]
},
"Network references": {
"type": "object",
"properties": {
"referenceResources": {
"type": "array",
"description": "List of network reference resources",
"items": {
"$ref": "#/components/schemas/Network reference resource"
}
}
},
"required": [
"referenceResources"
]
},
"Hotspot voucher detail page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Hotspot voucher details"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"Firewall zones page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Firewall zone"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"Firewall policy page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Firewall policy"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"IntegrationDnsPolicyPageDto": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DNS policy"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"Adopted device overview": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"macAddress": {
"type": "string",
"example": "94:2a:6f:26:c6:ca"
},
"ipAddress": {
"type": "string",
"example": "192.168.1.55"
},
"name": {
"type": "string",
"example": "IW HD"
},
"model": {
"type": "string",
"example": "UHDIW"
},
"state": {
"type": "string",
"enum": [
"ONLINE",
"OFFLINE",
"PENDING_ADOPTION",
"UPDATING",
"GETTING_READY",
"ADOPTING",
"DELETING",
"CONNECTION_INTERRUPTED",
"ISOLATED",
"U5G_INCORRECT_TOPOLOGY"
]
},
"supported": {
"type": "boolean"
},
"firmwareVersion": {
"type": "string",
"example": "6.6.55"
},
"firmwareUpdatable": {
"type": "boolean"
},
"features": {
"type": "array",
"items": {
"type": "string",
"enum": [
"switching",
"accessPoint",
"gateway"
]
},
"uniqueItems": true
},
"interfaces": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ports",
"radios"
]
},
"uniqueItems": true
}
},
"required": [
"features",
"firmwareUpdatable",
"id",
"interfaces",
"ipAddress",
"macAddress",
"model",
"name",
"state",
"supported"
]
},
"Adopted device overview page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Adopted device overview"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"Latest statistics for a device": {
"type": "object",
"properties": {
"uptimeSec": {
"type": "integer",
"format": "int64"
},
"lastHeartbeatAt": {
"type": "string",
"format": "date-time"
},
"nextHeartbeatAt": {
"type": "string",
"format": "date-time"
},
"loadAverage1Min": {
"type": "number",
"format": "double"
},
"loadAverage5Min": {
"type": "number",
"format": "double"
},
"loadAverage15Min": {
"type": "number",
"format": "double"
},
"cpuUtilizationPct": {
"type": "number",
"format": "double"
},
"memoryUtilizationPct": {
"type": "number",
"format": "double"
},
"uplink": {
"$ref": "#/components/schemas/Latest statistics for a device uplink interface"
},
"interfaces": {
"$ref": "#/components/schemas/Latest statistics for device interfaces"
}
},
"required": [
"interfaces"
]
},
"Latest statistics for a device uplink interface": {
"type": "object",
"properties": {
"txRateBps": {
"type": "integer",
"format": "int64"
},
"rxRateBps": {
"type": "integer",
"format": "int64"
}
}
},
"Latest statistics for device interfaces": {
"type": "object",
"properties": {
"radios": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Latest statistics for wireless radio"
}
}
}
},
"Latest statistics for wireless radio": {
"type": "object",
"properties": {
"frequencyGHz": {
"type": "number",
"enum": [
2.4,
5.0,
6.0,
60.0
]
},
"txRetriesPct": {
"type": "number",
"format": "double"
}
},
"required": [
"frequencyGHz"
]
},
"BooleanType": {
"$ref": "#/components/schemas/ScalarType"
},
"CompoundFilterExpression": {
"allOf": [
{
"$ref": "#/components/schemas/FilterExpression"
},
{
"type": "object",
"properties": {
"operator": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT"
]
},
"expressions": {
"type": "array",
"items": {}
}
}
}
]
},
"DecimalType": {
"$ref": "#/components/schemas/ScalarType"
},
"FilterExpression": {
"type": "object",
"description": "FilterExpression"
},
"FilterPath": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parent": {},
"depth": {
"type": "integer",
"format": "int32"
},
"names": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"FilterableEntity": {
"type": "object",
"properties": {
"path": {
"$ref": "#/components/schemas/FilterPath"
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/FilterableProperty"
}
},
"nestedEntities": {
"type": "object",
"additionalProperties": true
},
"name": {
"type": "string"
}
}
},
"FilterableProperty": {
"type": "object",
"properties": {
"path": {
"$ref": "#/components/schemas/FilterPath"
},
"type": {
"$ref": "#/components/schemas/FilterablePropertyType"
},
"name": {
"type": "string"
}
}
},
"FilterablePropertyType": {
"type": "object",
"properties": {
"allowedFunctions": {
"type": "array",
"items": {
"type": "string",
"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"
]
},
"uniqueItems": true
},
"valueType": {
"type": "string",
"enum": [
"STRING",
"INTEGER",
"DECIMAL",
"UUID",
"TIMESTAMP",
"BOOLEAN"
]
},
"supportedFunctions": {
"type": "array",
"items": {
"type": "string",
"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"
]
},
"uniqueItems": true
}
}
},
"IntegerType": {
"$ref": "#/components/schemas/ScalarType"
},
"NotFilterExpression": {
"allOf": [
{
"$ref": "#/components/schemas/FilterExpression"
},
{
"type": "object",
"properties": {
"expression": {}
}
}
]
},
"PropertyFilterExpression": {
"allOf": [
{
"$ref": "#/components/schemas/FilterExpression"
},
{
"type": "object",
"properties": {
"entity": {
"$ref": "#/components/schemas/FilterableEntity"
},
"property": {
"$ref": "#/components/schemas/FilterableProperty"
},
"function": {
"type": "string",
"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"
]
},
"arguments": {
"type": "array",
"items": {}
}
}
}
]
},
"ScalarType": {
"$ref": "#/components/schemas/FilterablePropertyType"
},
"SetType": {
"$ref": "#/components/schemas/FilterablePropertyType"
},
"StringType": {
"$ref": "#/components/schemas/ScalarType"
},
"TimestampType": {
"$ref": "#/components/schemas/ScalarType"
},
"UUIDType": {
"$ref": "#/components/schemas/ScalarType"
},
"Device tag": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1
},
"metadata": {
"$ref": "#/components/schemas/User or orchestrated entity metadata"
}
},
"required": [
"deviceIds",
"id",
"metadata",
"name"
]
},
"IntegrationDeviceTagPageDto": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device tag"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"Client access overview": {
"example": {
"type": "DEFAULT"
},
"type": "object"
},
"Client overview": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"connectedAt": {
"type": "string",
"format": "date-time"
},
"ipAddress": {
"type": "string"
},
"access": {
"$ref": "#/components/schemas/Client access overview"
}
},
"required": [
"access",
"id",
"name",
"type"
]
},
"Client overview page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Client overview"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"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"
}
]
},
"Guest access overview": {
"allOf": [
{
"$ref": "#/components/schemas/Local client access overview"
},
{
"type": "object",
"properties": {
"authorized": {
"type": "boolean"
}
},
"required": [
"authorized"
]
}
]
},
"Local client access overview": {
"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Teleport client (connection) overview": {
"allOf": [
{
"$ref": "#/components/schemas/Client overview"
},
{
"type": "object",
"properties": {
"access": {
"$ref": "#/components/schemas/Teleport client access overview"
}
},
"required": [
"access",
"id",
"name"
]
}
]
},
"Teleport client access overview": {
"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"VPN client (connection) overview": {
"allOf": [
{
"$ref": "#/components/schemas/Client overview"
},
{
"type": "object",
"properties": {
"access": {
"$ref": "#/components/schemas/VPN client access overview"
}
},
"required": [
"access",
"id",
"name"
]
}
]
},
"VPN client access overview": {
"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Wired client overview": {
"allOf": [
{
"$ref": "#/components/schemas/Client overview"
},
{
"type": "object",
"properties": {
"macAddress": {
"type": "string"
},
"uplinkDeviceId": {
"type": "string",
"format": "uuid"
},
"access": {
"$ref": "#/components/schemas/Local client access overview"
}
},
"required": [
"access",
"id",
"macAddress",
"name",
"uplinkDeviceId"
]
}
]
},
"Wireless client overview": {
"allOf": [
{
"$ref": "#/components/schemas/Client overview"
},
{
"type": "object",
"properties": {
"macAddress": {
"type": "string"
},
"uplinkDeviceId": {
"type": "string",
"format": "uuid"
},
"access": {
"$ref": "#/components/schemas/Local client access overview"
}
},
"required": [
"access",
"id",
"macAddress",
"name",
"uplinkDeviceId"
]
}
]
},
"Client details": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"connectedAt": {
"type": "string",
"format": "date-time"
},
"ipAddress": {
"type": "string"
},
"access": {}
},
"required": [
"access",
"id",
"name",
"type"
]
},
"Default client access details": {
"allOf": [
{
"$ref": "#/components/schemas/Local client access details"
},
{
"$ref": "#/components/schemas/VPN client access details"
},
{
"$ref": "#/components/schemas/Teleport client access details"
}
]
},
"Guest access details": {
"allOf": [
{
"$ref": "#/components/schemas/Local client access details"
},
{
"type": "object",
"properties": {
"authorized": {
"type": "boolean"
},
"authorization": {
"$ref": "#/components/schemas/Guest authorization details"
}
},
"required": [
"authorized"
]
}
]
},
"Local client access details": {
"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Teleport client (connection) details": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"connectedAt": {
"type": "string",
"format": "date-time"
},
"ipAddress": {
"type": "string"
},
"access": {
"$ref": "#/components/schemas/Teleport client access details"
}
},
"required": [
"access",
"id",
"name"
]
},
"Teleport client access details": {
"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"VPN client (connection) details": {
"allOf": [
{
"$ref": "#/components/schemas/Client details"
},
{
"type": "object",
"properties": {
"access": {
"$ref": "#/components/schemas/VPN client access details"
}
},
"required": [
"access",
"id",
"name"
]
}
]
},
"VPN client access details": {
"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Wired client details": {
"allOf": [
{
"$ref": "#/components/schemas/Client details"
},
{
"type": "object",
"properties": {
"macAddress": {
"type": "string"
},
"uplinkDeviceId": {
"type": "string",
"format": "uuid"
},
"access": {
"$ref": "#/components/schemas/Local client access details"
}
},
"required": [
"access",
"id",
"macAddress",
"name",
"uplinkDeviceId"
]
}
]
},
"Wireless client details": {
"allOf": [
{
"$ref": "#/components/schemas/Client details"
},
{
"type": "object",
"properties": {
"macAddress": {
"type": "string"
},
"uplinkDeviceId": {
"type": "string",
"format": "uuid"
},
"access": {
"$ref": "#/components/schemas/Local client access details"
}
},
"required": [
"access",
"id",
"macAddress",
"name",
"uplinkDeviceId"
]
}
]
},
"ACL ruleObject": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"enabled": {
"type": "boolean",
"example": true
},
"name": {
"type": "string",
"description": "ACL rule name",
"minLength": 1
},
"description": {
"type": "string",
"description": "ACL rule description"
},
"action": {
"type": "string",
"description": "ACL rule action",
"enum": [
"ALLOW",
"BLOCK"
],
"example": "ALLOW|BLOCK"
},
"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": {
"type": "integer",
"format": "int32",
"description": "ACL rule index. Lower index has higher priority",
"minimum": 0
},
"sourceFilter": {
"description": "Traffic source filter"
},
"destinationFilter": {
"description": "Traffic destination filter"
},
"metadata": {
"$ref": "#/components/schemas/User defined or derived entity metadata",
"description": "Only user-defined rules can be deleted or modified"
}
},
"required": [
"action",
"enabled",
"id",
"index",
"metadata",
"name",
"type"
]
},
"IntegrationAclRulePageDto": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ACL ruleObject"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"Device pending adoption": {
"type": "object",
"properties": {
"macAddress": {
"type": "string",
"example": "94:2a:6f:26:c6:ca"
},
"ipAddress": {
"type": "string",
"example": "192.168.1.55"
},
"model": {
"type": "string",
"example": "UHDIW"
},
"state": {
"type": "string",
"enum": [
"ONLINE",
"OFFLINE",
"PENDING_ADOPTION",
"UPDATING",
"GETTING_READY",
"ADOPTING",
"DELETING",
"CONNECTION_INTERRUPTED",
"ISOLATED",
"U5G_INCORRECT_TOPOLOGY"
]
},
"supported": {
"type": "boolean"
},
"firmwareVersion": {
"type": "string",
"example": "6.6.55"
},
"firmwareUpdatable": {
"type": "boolean"
},
"features": {
"type": "array",
"items": {
"type": "string",
"enum": [
"switching",
"accessPoint",
"gateway"
]
},
"uniqueItems": true
},
"adoptionTargetSiteIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"uniqueItems": true
}
},
"required": [
"adoptionTargetSiteIds",
"features",
"firmwareUpdatable",
"ipAddress",
"macAddress",
"model",
"state",
"supported"
]
},
"Device pending adoption page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device pending adoption"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"Application info": {
"type": "object",
"properties": {
"applicationVersion": {
"type": "string",
"example": "9.1.0"
}
},
"required": [
"applicationVersion"
]
},
"DPI category": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"example": "3|5"
},
"name": {
"type": "string",
"example": "Network protocols|Business tools"
}
},
"required": [
"id",
"name"
]
},
"DPI category page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DPI category"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"DPI application": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"example": "786435|720973"
},
"name": {
"type": "string",
"example": "Adobe Express|Zoom"
}
},
"required": [
"id",
"name"
]
},
"DPI application page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DPI application"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"Country Definition": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The country code in ISO 3166-1 alpha-2 format.",
"example": "CK|FK|KY"
},
"name": {
"type": "string",
"description": "The country name.",
"example": "Cook Islands|Falkland Islands, Malvinas|Cayman Islands"
}
},
"required": [
"code",
"name"
]
},
"Country definition page": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64",
"example": 0
},
"limit": {
"type": "integer",
"format": "int32",
"example": 25
},
"count": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalCount": {
"type": "integer",
"format": "int64",
"example": 1000
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Country Definition"
}
}
},
"required": [
"count",
"data",
"limit",
"offset",
"totalCount"
]
},
"Voucher deletion results": {
"type": "object",
"properties": {
"vouchersDeleted": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}