SmartCell Gateway 200 Public API Reference Guide

Body

{
  "ssid": "meshSSID"
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ssid": {
      "description": "SSID of the mesh network",
      "type": "string"
    },
    "passphrase": {
      "description": "Passphrase for the mesh network",
      "type": "string"
    }
  },
  "description": "Mesh configuration of the zone."
}

Body

{
  "domainId": "domainUUIDToMove",
  "name": "zoneModified",
  "description": "description modified",
  "countryCode": "US",
  "dfsChannelEnabled": false,
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "channelEvaluationInterval": 777,
  "bonjourFencingPolicyEnabled": true
}

Schema

{
  "domainId": {
    "description": "Identifier of the management domain to which the zone belongs",
    "type": "string"
  },
  "name": {
    "type": "string",
    "minLength": 2,
    "maxLength": 32,
    "pattern": "^[!-~]([ -~]){0,30}[!-~]$",
    "description": "Name of the zone"
  },
  "description": {
    "type": [
      "string",
      "null"
    ],
    "maxLength": 64,
    "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Description of the zone"
  },
  "countryCode": {
    "description": "Country code of the zone",
    "type": "string"
  },
  "dfsChannelEnabled": {
    "description": "DFS Channel enabled configuration of the zone, only for the US country code .",
    "type": "boolean"
  },
  "channelModeEnabled": {
    "description": "Channel mode configuration of the zone.",
    "type": "boolean"
  },
  "tunnelType": {
    "description": "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
    "enum": [
      "No_Tunneled",
      "RuckusGRE",
      "SoftGRE",
      "SoftGREIpsec"
    ]
  },
  "dosBarringEnable": {
    "description": "Enable DoS Protection(Barring UE) of the zone.",
    "type": "integer"
  },
  "dosBarringPeriod": {
    "description": "DoS Protection(Barring UE) blocking period of the zone.",
    "type": "integer"
  },
  "dosBarringThreshold": {
    "description": "DoS Protection(Barring UE) threshold of the zone.",
    "type": "integer"
  },
  "dosBarringCheckPeriod": {
    "description": "DoS Protection(Barring UE) check period of the zone.",
    "type": "integer"
  },
  "location": {
    "type": "string",
    "pattern": "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
    "description": "Location of the zone."
  },
  "locationAdditionalInfo": {
    "type": "string",
    "pattern": "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
    "description": "Location additional info of the zone."
  },
  "latitude": {
    "type": "number",
    "description": "Latitude coordinate (in decimal format) of the zone"
  },
  "longitude": {
    "type": "number",
    "description": "Longitude coordinate (in decimal format) of the zone"
  },
  "vlanOverlappingEnabled": {
    "description": "VLAN pooling overlapping of the zone",
    "type": "boolean"
  },
  "channelEvaluationInterval": {
    "description": "channel evaluation Interval of the zone",
    "type": "integer",
    "default": 600,
    "minimum": 60,
    "maximum": 3600
  },
  "ipv6TrafficFilterEnabled": {
    "description": "IPv6 Traffic filtering on the AP",
    "type": "integer"
  },
  "bonjourFencingPolicyEnabled": {
    "description": "Enable Bonjour Fencing Policy on the AP",
    "type": "boolean"
  }
}

Body

{
  "customizedTimezone": {
    "abbreviation": "ABC",
    "gmtOffset": 4,
    "gmtOffsetMinute": 10
  }
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "systemTimezone": {
      "description": "System defined time zone",
      "type": "string"
    },
    "customizedTimezone": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "abbreviation": {
          "description": "Time zone abbreviation",
          "type": "string",
          "pattern": "^[a-zA-Z]{3,4}$"
        },
        "gmtOffset": {
          "description": "GMT offset ",
          "type": "integer",
          "minimum": -11,
          "maximum": 14
        },
        "gmtOffsetMinute": {
          "description": "GMT offset minute",
          "type": "integer",
          "minimum": 0,
          "maximum": 59
        },
        "start": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "month": {
              "description": "Month when daylight saving time begins",
              "enum": [
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12
              ]
            },
            "week": {
              "description": "Week of the month (1 for the first week, 2 for the second week, and so on)",
              "enum": [
                1,
                2,
                3,
                4,
                5
              ]
            },
            "day": {
              "description": "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6
              ]
            },
            "hour": {
              "description": "Hour of the day",
              "type": "integer",
              "minimum": 0,
              "maximum": 23
            }
          },
          "required": [
            "month",
            "week",
            "day",
            "hour"
          ],
          "description": "Daylight saving time start"
        },
        "end": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "month": {
              "description": "Month when daylight saving time begins",
              "enum": [
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12
              ]
            },
            "week": {
              "description": "Week of the month (1 for the first week, 2 for the second week, and so on)",
              "enum": [
                1,
                2,
                3,
                4,
                5
              ]
            },
            "day": {
              "description": "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6
              ]
            },
            "hour": {
              "description": "Hour of the day",
              "type": "integer",
              "minimum": 0,
              "maximum": 23
            }
          },
          "required": [
            "month",
            "week",
            "day",
            "hour"
          ],
          "description": "Daylight saving time end"
        }
      },
      "required": [
        "abbreviation",
        "gmtOffset",
        "gmtOffsetMinute"
      ],
      "description": "User defined time zone"
    }
  },
  "description": "Either systemTimezone or customizedTimezone must be specified"
}

Body

{
  "apLoginName": "apLoginName",
  "apLoginPassword": "apLoginPassword"
}

Schema

{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "apLoginName" : {
            "type" : "string",
            "maxLength" : 64,
            "pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
            "description" : "User name of the AP administrator"
        },
        "apLoginPassword" : {
            "type" : "string",
            "maxLength" : 64,
            "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
            "description" : "Password of the AP administrator"
        }
    },
    "required" : [ "apLoginName", "apLoginPassword" ],
    "description" : "AP administrator account"
}

Body

{
  "txPower": "Full",
  "channelWidth": 20,
  "channel": 0,
  "channelRange": [
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
    9,
    10,
    11
  ]
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "txPower": {
      "enum": [
        "Full",
        "-1dB",
        "-2dB",
        "-3dB(1/2)",
        "-4dB",
        "-5dB",
        "-6dB(1/4)",
        "-7dB",
        "-8dB",
        "-9dB(1/8)",
        "-10dB",
        "Min"
      ],
      "description": "Transmission power"
    },
    "channelWidth": {
      "description": "Channel width. Zero (0) means Auto.",
      "enum": [
        0,
        20,
        40
      ]
    },
    "channel": {
      "description": "Channel number",
      "type": "integer"
    },
    "channelRange": {
      "description": "Channel range options",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "description": "AP 2.4GHz radio configuration of the zone."
}

Body

{
  "txPower": "-1dB",
  "channelWidth": 40,
  "indoorChannel": 0,
  "outdoorChannel": 0,
  "indoorChannelRange": [
    36,
    40,
    44,
    48,
    149,
    153,
    157,
    161
  ],
  "outdoorChannelRange": [
    149,
    153,
    157,
    161
  ]
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "txPower": {
      "enum": [
        "Full",
        "-1dB",
        "-2dB",
        "-3dB(1/2)",
        "-4dB",
        "-5dB",
        "-6dB(1/4)",
        "-7dB",
        "-8dB",
        "-9dB(1/8)",
        "-10dB",
        "Min"
      ],
      "description": "Transmission power"
    },
    "channelWidth": {
      "description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
      "enum": [
        0,
        20,
        40,
        80,
        8080,
        160
      ]
    },
    "indoorChannel": {
      "description": "Channel number for Indoor AP",
      "type": "integer"
    },
    "outdoorChannel": {
      "description": "Channel number for Outdoor AP",
      "type": "integer"
    },
    "indoorSecondaryChannel": {
      "description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
      "type": "integer"
    },
    "outdoorSecondaryChannel": {
      "description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
      "type": "integer"
    },
    "indoorChannelRange": {
      "description": "Channel range options for Indoor AP",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "outdoorChannelRange": {
      "description": "Channel range options for outdoor AP",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "description": "AP 5GHz radio configuration of the zone."
}

Body

{
  "address": "1.1.1.1",
  "port": 514,
  "facility": "keep_Original",
  "priority": "Error"
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "address": {
      "type": "string",
      "description": "Address of the syslog server."
    },
    "port": {
      "description": "Port number of the syslog server",
      "type": "integer",
      "default": 514,
      "minimum": 1,
      "maximum": 65535
    },
    "facility": {
      "description": "Facility of the syslog server",
      "enum": [
        "Keep_Original",
        "Local0",
        "Local1",
        "Local2",
        "Local3",
        "Local4",
        "Local5",
        "Local6",
        "Local7"
      ],
      "default": "keep_Original"
    },
    "priority": {
      "description": "Priority of the log messages",
      "enum": [
        "Emergency",
        "Alert",
        "Critical",
        "Error",
        "Warning",
        "Notice",
        "Info",
        "All"
      ],
      "default": "Error"
    }
  },
  "description": "Syslog configuration of the zone."
}

Body

{
  "intervalInSec": 10,
  "retryThreshold": 3
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "intervalInSec": {
      "description": "Interval in seconds. This is required if smartMonitor is enabled",
      "type": "integer",
      "default": 10,
      "minimum": 5,
      "maximum": 60
    },
    "retryThreshold": {
      "description": "Retry threshold. This is required if smartMonitor is enabled",
      "type": "integer",
      "default": 3,
      "minimum": 1,
      "maximum": 10
    }
  },
  "description": "Smart monitor configuration of the zone."
}

Body

{
  "maxRadioLoadPercent": 75,
  "minClientCount": "10",
  "minClientThroughputMbps": 0
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "maxRadioLoadPercent": {
      "description": "Maximum radio load percentage.",
      "type": "integer",
      "default": 75,
      "minimum": 50,
      "maximum": 100
    },
    "minClientCount": {
      "description": "Minimum client count number.",
      "type": "integer",
      "default": 10,
      "minimum": 0,
      "maximum": 100
    },
    "minClientThroughputMbps": {
      "description": "Minimum client throughput in Mbps.",
      "type": "number",
      "default": 0,
      "minimum": 0,
      "maximum": 100
    }
  },
  "description": "AP client admission control 2.4GHz radio configuration of the zone."
}

Body

{
  "maxRadioLoadPercent": 75,
  "minClientCount": "10",
  "minClientThroughputMbps": 0
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "maxRadioLoadPercent": {
      "description": "Maximum radio load percentage.",
      "type": "integer",
      "default": 75,
      "minimum": 50,
      "maximum": 100
    },
    "minClientCount": {
      "description": "Minimum client count number.",
      "type": "integer",
      "default": 10,
      "minimum": 0,
      "maximum": 100
    },
    "minClientThroughputMbps": {
      "description": "Minimum client throughput in Mbps.",
      "type": "number",
      "default": 0,
      "minimum": 0,
      "maximum": 100
    }
  },
  "description": "AP client admission control 5GHz radio configuration of the zone."
}

Body

{
  "frequencyInSec": 20
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "frequencyInSec": {
      "description": "Frequency in second",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    }
  },
  "description": "Background scanning on 2.4GHz radio configuration of the zone."
}

Body

{
  "frequencyInSec": 20
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "frequencyInSec": {
      "description": "Frequency in second",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    }
  },
  "description": "Background scanning on 5GHz radio configuration of the zone."
}

Body

{
  "adjacentRadioThreshold": 12
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "adjacentRadioThreshold": {
      "description": "Adjacent radio threshold",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "description": "Client load balancing on 2.4GHz radio configuration of the zone."
}

Body

{
  "adjacentRadioThreshold": 12
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "adjacentRadioThreshold": {
      "description": "Adjacent radio threshold",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "description": "Client load balancing on 5GHz radio configuration of the zone."
}

Body

{
  "wifi24Percentage": 10
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "wifi24Percentage": {
      "description": "Percentage of client load on 2.4GHz radio band",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    }
  },
  "description": "Band balancing configuration of the zone."
}

Body

{
  "gatewayLossTimeoutInSec": 1800,
  "serverLossTimeoutInSec": 7200
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "gatewayLossTimeoutInSec": {
      "description": "Gateway loss timeout in second",
      "enum": [
        0,
        1800,
        3600,
        5400,
        7200,
        9000,
        10800,
        12600,
        14400,
        16200,
        18000,
        19800,
        23400,
        25200,
        27000,
        28800,
        30600,
        32400,
        34200,
        36000,
        37800,
        39600,
        41400,
        43200,
        45000,
        46800,
        48600,
        50400,
        52200,
        54000,
        55800,
        57600,
        59400,
        61200,
        63000,
        64800,
        66600,
        68400,
        70200,
        72000,
        73800,
        75600,
        77400,
        79200,
        81000,
        82800,
        84600,
        86400
      ]
    },
    "serverLossTimeoutInSec": {
      "description": "Server loss timeout in second",
      "enum": [
        0,
        7200,
        14400,
        21600,
        28800,
        36000,
        43200,
        50400,
        57600,
        64800,
        72000,
        79200,
        86400
      ]
    }
  },
  "description": "AP reboot timeout of the zone."
}

Body

{
  "id": "nodeAffinityProfileId",
  "name": "nodeAffinityProfileName"
}

Schema

{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Node affinity profile of the zone."
}

Body

{
  "id": "venueProfileId",
  "name": "venueProfileName"
}

Schema

{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Venue profile configuration of the zone."
}

Body

{
  "reportType": "All",
  "maliciousTypes": null,
  "protectionEnabled": true
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "reportType": {
      "description": "Report type",
      "enum": [
        "All",
        "Malicious"
      ]
    },
    "maliciousTypes": {
      "description": "Malicious type when reportType is Malicious",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "enum": [
          "SSIDSpoofing",
          "SameNetwork",
          "MACSpoofing"
        ]
      }
    },
    "protectionEnabled": {
      "description": "Protection enabled",
      "type": "boolean"
    }
  },
  "description": "Rogue AP detection configuration of the zone."
}

Body

{
  "id": "lbsId",
  "name": "lbsName"
}

Schema

{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "Location based service configuration of the zone."
}

Body

{
  "channelSelectMode": "ChannelFly",
  "channelFlyMtbc": 480
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "channelSelectMode": {
      "description": "Channel Select Mode",
      "enum": [
        "None",
        "BackgroundScanning",
        "ChannelFly"
      ]
    },
    "channelFlyMtbc": {
      "description": "ChannelFly MTBC",
      "type": "integer",
      "default": 480,
      "minimum": 100,
      "maximum": 1440
    }
  },
  "description": "client load balancing on Radio 2.4G, auto channel selection mode"
}

Body

{
  "channelSelectMode": "BackgroundScanning",
  "channelFlyMtbc": 480
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "channelSelectMode": {
      "description": "Channel Select Mode",
      "enum": [
        "None",
        "BackgroundScanning",
        "ChannelFly"
      ]
    },
    "channelFlyMtbc": {
      "description": "ChannelFly MTBC",
      "type": "integer",
      "default": 480,
      "minimum": 100,
      "maximum": 1440
    }
  },
  "description": "client load balancing on Radio 5G, auto channel selection mode"
}

Body

{
  "id": "ipsecProfileId",
  "name": "ipsecProfileName"
}

Schema

{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "description": "ipsec profile configuration of the Zone."
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "usbSoftware": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "description": "APUsbSoftwarePackage id or name"
    },
    "applyModel": {
      "description": "List of apply models",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "description": "APUsbSoftwarePackage of the zone"
}

Body

{
  "id": 1,
  "mode": "KEEP"
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "mode": {
      "description": "Vlan Mode of the zone",
      "enum": [
        "KEEP",
        "USER_DEFINED"
      ]
    },
    "id": {
      "description": "Vlan id of the zone",
      "type": "integer"
    }
  },
  "description": "ap Management Vlan of the zone"
}

Body

{
  "altitudeUnit": "meters",
  "altitudeValue": 1
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "altitudeUnit": {
      "description": "altitude unit",
      "enum": [
        "meters",
        "floor"
      ]
    },
    "altitudeValue": {
      "description": "altitude value",
      "type": "integer"
    }
  },
  "description": "GPS Altitude"
}