Manage APs including pinging, trace-routing, resetting, rebooting, floor-plan positioning, bonjour gateway and LAN-Ports settings.
Get the AP list.
| tenantId required | string Tenant ID |
| page | string page |
| size | string size |
| operational | string Default: "true" Include operational data in response |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found.
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "apGroupId": "string",
- "clientCount": 0,
- "description": "string",
- "externalIp": "string",
- "firmware": "string",
- "indoorModel": true,
- "ip": "string",
- "lastContacted": "string",
- "lastUpdated": "string",
- "mac": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
]Add a list of new APs.
| tenantId required | string Tenant ID |
AP
| apGroupId | string AP-group ID |
| description | string [ 0 .. 180 ] characters Description of the AP |
| name required | string (?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$ AP name |
| position | object (APPosition) AP Position |
| serialNumber required | string ^[1-9][0-9]{11}$ AP Serial-Number |
| tags | Array of strings |
| venueId required | string Venue ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Insufficient license [ENT-10003: "Insufficient Licenses"]
Not-authorized
Requested resource or related-entity not found
Conflict [WIFI-10120: "Non-unique AP name", APR-10130: "Serial Already Registered"]
Validation error [WIFI-10114: "The Service is currently not supported in the country which you entered"]
Locked
Internal Server Error
USA & North America
Europe
[- {
- "apGroupId": "string",
- "description": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "serialNumber": "string",
- "tags": [
- "string"
], - "venueId": "string"
}
]{- "requestId": "string",
- "response": [
- {
- "apGroupId": "string",
- "clientCount": 0,
- "description": "string",
- "externalIp": "string",
- "firmware": "string",
- "indoorModel": true,
- "ip": "string",
- "lastContacted": "string",
- "lastUpdated": "string",
- "mac": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
]
}Delete a list of APs.
| tenantId required | string Tenant ID |
List of AP serial-numbers
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- "string"
]{- "requestId": "string"
}Get the APs in the AP-group.
| tenantId required | string Tenant ID |
| apGroupId required | string AP-group ID |
| page | string page |
| size | string size |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "apGroupId": "string",
- "clientCount": 0,
- "description": "string",
- "externalIp": "string",
- "firmware": "string",
- "indoorModel": true,
- "ip": "string",
- "lastContacted": "string",
- "lastUpdated": "string",
- "mac": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
]Get the AP operational and configuration data.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
| operational | string Default: "true" Include operational data in response |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "apGroupId": "string",
- "cellularSettings": {
- "primaryWanRecoveryTimer": 10,
- "simCardPrimaryApn": "string",
- "simCardPrimaryCellularNetworkSelection": "AUTO",
- "simCardPrimaryEnabled": true,
- "simCardPrimaryRoaming": true,
- "simCardSecondaryApn": "string",
- "simCardSecondaryCellularNetworkSelection": "AUTO",
- "simCardSecondaryEnabled": true,
- "simCardSecondaryRoaming": true,
- "useVenueSettings": true,
- "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}, - "clientCount": 0,
- "description": "string",
- "externalIp": "string",
- "firmware": "string",
- "indoorModel": true,
- "ip": "string",
- "lanPorts": {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": null,
- "useVenueSettings": false
}, - "lastContacted": "string",
- "lastUpdated": "string",
- "mac": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}Update an AP.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
AP
| apGroupId | string AP-group ID |
| description | string [ 0 .. 180 ] characters Description of the AP |
| name required | string (?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$ AP name |
| position | object (APPosition) AP Position |
| serialNumber required | string ^[1-9][0-9]{11}$ AP Serial-Number |
| tags | Array of strings |
| venueId required | string Venue ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Insufficient license [ENT-10003: "Insufficient Licenses"]
Not-authorized
Requested resource or related-entity not found
Conflict [WIFI-10120: "Non-unique AP name"]
Validation error [WIFI-10114: "The Service is currently not supported in the country which you entered"]
Locked
Internal Server Error
USA & North America
Europe
{- "apGroupId": "string",
- "description": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "serialNumber": "string",
- "tags": [
- "string"
], - "venueId": "string"
}{- "requestId": "string",
- "response": {
- "apGroupId": "string",
- "clientCount": 0,
- "description": "string",
- "externalIp": "string",
- "firmware": "string",
- "indoorModel": true,
- "ip": "string",
- "lastContacted": "string",
- "lastUpdated": "string",
- "mac": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
}Delete an AP.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Get the AP bonjour gateway details.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}Update an AP bonjour gateway.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
Bonjour gateway
| rules required | Array of objects (BonjourGatewayRule) |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}{- "requestId": "string",
- "response": {
- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}
}Reset an AP bonjour gateway.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Download the AP log file.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "fileURL": "string"
}Perform a factory reset on an AP.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Get AP LAN-ports details.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": null,
- "useVenueSettings": false
}Update LAN-ports of an AP.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
AP LAN-Ports
| lanPorts | Array of objects (APLanPort) |
| poeOut | boolean Default: null True if POE out is enabled |
| useVenueSettings | boolean Default: false True if using Venue POE settings |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10108: "AP LAN-Port type is Trunk and UntagId != 1", WIFI-10109: "AP LAN-Port type is Access and UntagId is not equals to VlanMembers"]
Locked
Internal Server Error
USA & North America
Europe
{- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": null,
- "useVenueSettings": false
}{- "requestId": "string",
- "response": {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": null,
- "useVenueSettings": false
}
}Reset the LAN-ports of an AP to the default values.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Perform a ping to the AP.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
AP Ping-request
| targetHost required | string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b)$) |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "targetHost": "string"
}{- "requestId": "string",
- "response": {
- "response": "string"
}
}Update an AP floor-plan position.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
AP position
| floorplanId | string |
| xPercent | number <float> [ 0 .. 100 ] |
| yPercent | number <float> [ 0 .. 100 ] |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}{- "requestId": "string",
- "response": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}Get AP radio details.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}Update an AP radio settings.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
AP Radio
| apRadioParams24G | object (APRadioParams24G) AP Radio params for 2.4 Ghz |
| apRadioParams50G | object (APRadioParams50G) AP Radio params for 5 Ghz |
| enable24G | boolean Default: null True if 2.4 Ghz is enabled |
| enable50G | boolean Default: null True if 5 Ghz is enabled |
| useVenueSettings | boolean Default: true True if using Venue settings |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10110: "Radio Params 2.4G, Allowed Channel List, At Least Two Channels Should Be Selected", WIFI-10111: "Radio Params 5G, Allowed Indoor Channel List, At Least Two Channels Should Be Selected", WIFI-10112: "Radio Params 5G, Allowed Outdoor Channel List, At Least Two Channels Should Be Selected"]
Locked
Internal Server Error
USA & North America
Europe
{- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}{- "requestId": "string",
- "response": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}
}Reset AP radio to default settings.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string",
- "response": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}
}Reboot an AP.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Perform a trace-route on an AP.
| tenantId required | string Tenant ID |
| serialNumber required | string The serial number of the AP. |
AP Trace-route request
| targetHost required | string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b)$) |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "targetHost": "string"
}{- "requestId": "string",
- "response": {
- "response": "string"
}
}Get the AP-group list.
| tenantId required | string Tenant ID |
| page | string page |
| size | string size |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "aps": [
- {
- "apGroupId": "string",
- "cellularSettings": {
- "primaryWanRecoveryTimer": 10,
- "simCardPrimaryApn": "string",
- "simCardPrimaryCellularNetworkSelection": "AUTO",
- "simCardPrimaryEnabled": true,
- "simCardPrimaryRoaming": true,
- "simCardSecondaryApn": "string",
- "simCardSecondaryCellularNetworkSelection": "AUTO",
- "simCardSecondaryEnabled": true,
- "simCardSecondaryRoaming": true,
- "useVenueSettings": true,
- "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}, - "clientCount": 0,
- "description": "string",
- "externalIp": "string",
- "firmware": "string",
- "indoorModel": true,
- "ip": "string",
- "lanPorts": {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": null,
- "useVenueSettings": false
}, - "lastContacted": "string",
- "lastUpdated": "string",
- "mac": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
], - "description": "string",
- "id": "string",
- "isDefault": false,
- "name": "string",
- "venueId": "string"
}
]Create a new AP-group.
| tenantId required | string Tenant ID |
AP-Group
| name required | string [ 2 .. 64 ] characters Name of the AP-group |
| description | string [ 2 .. 180 ] characters Description of the AP-group |
| venueId required | string Immutable: The venue is set when creating the AP-group, and cannot be changed afterwards. |
| apSerialNumbers | Array of objects (APSerialNumber) |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "name": "string",
- "description": "string",
- "venueId": "string",
- "apSerialNumbers": [
- {
- "serialNumber": "string"
}
]
}{- "requestId": "string",
- "response": {
- "aps": [
- {
- "apGroupId": "string",
- "cellularSettings": {
- "primaryWanRecoveryTimer": 10,
- "simCardPrimaryApn": "string",
- "simCardPrimaryCellularNetworkSelection": "AUTO",
- "simCardPrimaryEnabled": true,
- "simCardPrimaryRoaming": true,
- "simCardSecondaryApn": "string",
- "simCardSecondaryCellularNetworkSelection": "AUTO",
- "simCardSecondaryEnabled": true,
- "simCardSecondaryRoaming": true,
- "useVenueSettings": true,
- "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}, - "clientCount": 0,
- "description": "string",
- "externalIp": "string",
- "firmware": "string",
- "indoorModel": true,
- "ip": "string",
- "lanPorts": {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": null,
- "useVenueSettings": false
}, - "lastContacted": "string",
- "lastUpdated": "string",
- "mac": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
], - "description": "string",
- "id": "string",
- "isDefault": false,
- "name": "string",
- "venueId": "string"
}
}Delete a list of AP-groups.
| tenantId required | string Tenant ID |
List of AP-group IDs
AP-group ID
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- "string"
]{- "requestId": "string"
}Get the AP-group details.
| apGroupId required | string AP-group ID |
| tenantId required | string Tenant ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "aps": [
- {
- "apGroupId": "string",
- "cellularSettings": {
- "primaryWanRecoveryTimer": 10,
- "simCardPrimaryApn": "string",
- "simCardPrimaryCellularNetworkSelection": "AUTO",
- "simCardPrimaryEnabled": true,
- "simCardPrimaryRoaming": true,
- "simCardSecondaryApn": "string",
- "simCardSecondaryCellularNetworkSelection": "AUTO",
- "simCardSecondaryEnabled": true,
- "simCardSecondaryRoaming": true,
- "useVenueSettings": true,
- "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}, - "clientCount": 0,
- "description": "string",
- "externalIp": "string",
- "firmware": "string",
- "indoorModel": true,
- "ip": "string",
- "lanPorts": {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": null,
- "useVenueSettings": false
}, - "lastContacted": "string",
- "lastUpdated": "string",
- "mac": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
], - "description": "string",
- "id": "string",
- "isDefault": false,
- "name": "string",
- "venueId": "string"
}Update an AP-group.
| apGroupId required | string AP-group ID |
| tenantId required | string Tenant ID |
AP-Group
| name required | string [ 2 .. 64 ] characters Name of the AP-group |
| description | string [ 2 .. 180 ] characters Description of the AP-group |
| venueId required | string Immutable: The venue is set when creating the AP-group, and cannot be changed afterwards. |
| apSerialNumbers | Array of objects (APSerialNumber) |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "name": "string",
- "description": "string",
- "venueId": "string",
- "apSerialNumbers": [
- {
- "serialNumber": "string"
}
]
}{- "requestId": "string",
- "response": {
- "aps": [
- {
- "apGroupId": "string",
- "cellularSettings": {
- "primaryWanRecoveryTimer": 10,
- "simCardPrimaryApn": "string",
- "simCardPrimaryCellularNetworkSelection": "AUTO",
- "simCardPrimaryEnabled": true,
- "simCardPrimaryRoaming": true,
- "simCardSecondaryApn": "string",
- "simCardSecondaryCellularNetworkSelection": "AUTO",
- "simCardSecondaryEnabled": true,
- "simCardSecondaryRoaming": true,
- "useVenueSettings": true,
- "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}, - "clientCount": 0,
- "description": "string",
- "externalIp": "string",
- "firmware": "string",
- "indoorModel": true,
- "ip": "string",
- "lanPorts": {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": null,
- "useVenueSettings": false
}, - "lastContacted": "string",
- "lastUpdated": "string",
- "mac": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
], - "description": "string",
- "id": "string",
- "isDefault": false,
- "name": "string",
- "venueId": "string"
}
}Delete an AP-group.
| tenantId required | string Tenant ID |
| apGroupId required | string AP-group ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Get the AP-group list by venue.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
| page | string page |
| size | string size |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "aps": [
- {
- "apGroupId": "string",
- "cellularSettings": {
- "primaryWanRecoveryTimer": 10,
- "simCardPrimaryApn": "string",
- "simCardPrimaryCellularNetworkSelection": "AUTO",
- "simCardPrimaryEnabled": true,
- "simCardPrimaryRoaming": true,
- "simCardSecondaryApn": "string",
- "simCardSecondaryCellularNetworkSelection": "AUTO",
- "simCardSecondaryEnabled": true,
- "simCardSecondaryRoaming": true,
- "useVenueSettings": true,
- "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}, - "clientCount": 0,
- "description": "string",
- "externalIp": "string",
- "firmware": "string",
- "indoorModel": true,
- "ip": "string",
- "lanPorts": {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": null,
- "useVenueSettings": false
}, - "lastContacted": "string",
- "lastUpdated": "string",
- "mac": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
], - "description": "string",
- "id": "string",
- "isDefault": false,
- "name": "string",
- "venueId": "string"
}
]Get venue default AP-group details.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "aps": [
- {
- "apGroupId": "string",
- "cellularSettings": {
- "primaryWanRecoveryTimer": 10,
- "simCardPrimaryApn": "string",
- "simCardPrimaryCellularNetworkSelection": "AUTO",
- "simCardPrimaryEnabled": true,
- "simCardPrimaryRoaming": true,
- "simCardSecondaryApn": "string",
- "simCardSecondaryCellularNetworkSelection": "AUTO",
- "simCardSecondaryEnabled": true,
- "simCardSecondaryRoaming": true,
- "useVenueSettings": true,
- "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}, - "bonjourGateway": {
- "rules": [
- {
- "enabled": false,
- "fromVlan": 1,
- "mdnsName": "string",
- "mdnsProtocol": "TCP",
- "service": "AIRDISK",
- "toVlan": 1
}
]
}, - "clientCount": 0,
- "description": "string",
- "externalIp": "string",
- "firmware": "string",
- "indoorModel": true,
- "ip": "string",
- "lanPorts": {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "poeOut": null,
- "useVenueSettings": false
}, - "lastContacted": "string",
- "lastUpdated": "string",
- "mac": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "radio": {
- "apRadioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "apRadioParams50G": {
- "allowedChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "manualChannel": 0,
- "method": "BACKGROUND_SCANNING",
- "operativeChannel": 0,
- "operativeTxPower": "string",
- "snr_dB": 0,
- "txPower": "MAX"
}, - "enable24G": null,
- "enable50G": null,
- "useVenueSettings": true
}, - "serialNumber": "string",
- "state": "InSetupPhase",
- "subState": "NeverContactedCloud",
- "tags": [
- "string"
], - "uptime_seconds": 0,
- "venueId": "string"
}
], - "description": "string",
- "id": "string",
- "isDefault": false,
- "name": "string",
- "venueId": "string"
}Manage Wi-Fi venue configuration, including radio settings, mesh, LEDs, LAN-ports, syslogs, and vSPoT server.
Get the venue list.
| tenantId required | string Tenant ID |
| page | string page |
| size | string size |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "apPassword": "string",
- "bandBalancing": {
- "clientPercent24": 25,
- "enabled": false
}, - "dhcpServiceSetting": {
- "enabled": true,
- "mode": "EnableOnEachAPs",
- "wanPortSelectionMode": "Dynamic"
}, - "id": "string",
- "mesh": {
- "enabled": false
}, - "radioCustomization": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}
}, - "syslog": {
- "enabled": false,
- "facility": "KEEP_ORIGINAL",
- "flowLevel": "CLIENT_FLOW",
- "port": 514,
- "priority": "INFO",
- "protocol": "UDP",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP",
- "secondaryServer": "string",
- "server": "string"
}, - "tenantId": "string"
}
]Get the venue Wi-Fi details.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "apPassword": "string",
- "bandBalancing": {
- "clientPercent24": 25,
- "enabled": false
}, - "dhcpServiceSetting": {
- "enabled": true,
- "mode": "EnableOnEachAPs",
- "wanPortSelectionMode": "Dynamic"
}, - "id": "string",
- "mesh": {
- "enabled": false
}, - "radioCustomization": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}
}, - "syslog": {
- "enabled": false,
- "facility": "KEEP_ORIGINAL",
- "flowLevel": "CLIENT_FLOW",
- "port": 514,
- "priority": "INFO",
- "protocol": "UDP",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP",
- "secondaryServer": "string",
- "server": "string"
}, - "tenantId": "string"
}Get venue cellular settings. The settings are defined per AP model.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "model": "string",
- "primaryWanRecoveryTimer": 10,
- "simCardPrimaryApn": "string",
- "simCardPrimaryCellularNetworkSelection": "AUTO",
- "simCardPrimaryEnabled": true,
- "simCardPrimaryRoaming": true,
- "simCardSecondaryApn": "string",
- "simCardSecondaryCellularNetworkSelection": "AUTO",
- "simCardSecondaryEnabled": true,
- "simCardSecondaryRoaming": true,
- "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}
]Update venue cellular settings. The settings are defined per AP model.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
AP-Model Celluar
| model | string [ 0 .. 64 ] characters |
| primaryWanRecoveryTimer required | integer <int32> [ 10 .. 300 ] |
| simCardPrimaryApn | string ^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$ |
| simCardPrimaryCellularNetworkSelection required | string Enum: "AUTO" "LTE" "ThreeG" |
| simCardPrimaryEnabled | boolean default: true |
| simCardPrimaryRoaming | boolean default: true |
| simCardSecondaryApn | string ^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$ |
| simCardSecondaryCellularNetworkSelection required | string Enum: "AUTO" "LTE" "ThreeG" |
| simCardSecondaryEnabled | boolean default: true |
| simCardSecondaryRoaming | boolean default: true |
| wanConnection required | string Enum: "ETH_WITH_CELLULAR_FAILOVER" "CELLULAR_WITH_ETH_FAILOVER" "ETH" "CELLULAR" |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10170: "At least one SIM card has to be enabled"]
Locked
Internal Server Error
USA & North America
Europe
[- {
- "model": "string",
- "primaryWanRecoveryTimer": 10,
- "simCardPrimaryApn": "string",
- "simCardPrimaryCellularNetworkSelection": "AUTO",
- "simCardPrimaryEnabled": true,
- "simCardPrimaryRoaming": true,
- "simCardSecondaryApn": "string",
- "simCardSecondaryCellularNetworkSelection": "AUTO",
- "simCardSecondaryEnabled": true,
- "simCardSecondaryRoaming": true,
- "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}
]{- "requestId": "string",
- "response": [
- {
- "model": "string",
- "primaryWanRecoveryTimer": 10,
- "simCardPrimaryApn": "string",
- "simCardPrimaryCellularNetworkSelection": "AUTO",
- "simCardPrimaryEnabled": true,
- "simCardPrimaryRoaming": true,
- "simCardSecondaryApn": "string",
- "simCardSecondaryCellularNetworkSelection": "AUTO",
- "simCardSecondaryEnabled": true,
- "simCardSecondaryRoaming": true,
- "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}
]
}Get the list of DHCP service-profiles bound with the venue.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "dhcpServiceProfileId": "string",
- "venueId": "string"
}
]Bind a venue with a DHCP service-profile.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
| dhcpServiceProfileId required | string DHCP Service-Profile ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Conflict [WIFI-10152: "DHCP Service Profile and Venue mapping already exist"]
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string",
- "response": {
- "dhcpServiceProfileId": "string",
- "venueId": "string"
}
}Unbind a venue from a DHCP service-profile.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
| dhcpServiceProfileId required | string DHCP Service-Profile ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10151: "DHCP Service Profile and Venue mapping not found"]
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}List venue LAN-port settings. The settings are defined per AP model.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "model": "string",
- "poeMode": "Auto",
- "poeOut": null
}
]Update a venue LAN-port settings. The settings are defined per AP model.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
AP-Model LAN-Port
| lanPorts | Array of objects (VenueLanPort) |
| model | string [ 0 .. 64 ] characters |
| poeMode | string Enum: "Auto" "802.3af" "802.3at" "802.3bt-Class_5" "802.3bt-Class_6" "802.3bt-Class_7" "802.3bt-Class_8" |
| poeOut | boolean Default: null True if POE out is enabled |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10108: "AP LanPort type is Trunk and UntagId != 1", WIFI-10109: "AP LanPort type is Access and UntagId is not equals to VlanMembers"]
Locked
Internal Server Error
USA & North America
Europe
[- {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "model": "string",
- "poeMode": "Auto",
- "poeOut": null
}
]{- "requestId": "string",
- "response": [
- {
- "lanPorts": [
- {
- "enabled": true,
- "portId": "string",
- "type": "ACCESS",
- "untagId": 1,
- "vlanMembers": "string"
}
], - "model": "string",
- "poeMode": "Auto",
- "poeOut": null
}
]
}Get venue LED settings. The settings are defined per AP model.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "ledEnabled": null,
- "model": "string"
}
]Update venue LED settings. The settings are defined per AP model.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
AP-Model LED
| ledEnabled | boolean Default: null True if LED is enabled |
| model | string [ 0 .. 64 ] characters |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10108: "AP LanPort type is Trunk and UntagId != 1", WIFI-10109: "AP LanPort type is Access and UntagId is not equals to VlanMembers"]
Locked
Internal Server Error
USA & North America
Europe
[- {
- "ledEnabled": null,
- "model": "string"
}
]{- "requestId": "string",
- "response": [
- {
- "ledEnabled": null,
- "model": "string"
}
]
}Update the venue mesh.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
Mesh
| enabled | boolean Default: false default: false |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Conflict [WIFIB-10001: "Disabling mesh with active APs is not allowed"]
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "enabled": false
}{- "requestId": "string",
- "response": {
- "enabled": false
}
}Get the venue radio.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}
}Update the venue radio.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
Venue Radio
| radioParams24G | object (RadioParams24G) Radio customization for 2.4 Ghz |
| radioParams50G | object (RadioParams50G) Radio customization for 5 Ghz |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10110: "Radio Params 2.4G, Allowed Channel List, At Least Two Channels Should Be Selected", WIFI-10111: "Radio Params 5G, Allowed Indoor Channel List, At Least Two Channels Should Be Selected", WIFI-10112: "Radio Params 5G, Allowed Outdoor Channel List, At Least Two Channels Should Be Selected"]
Locked
Internal Server Error
USA & North America
Europe
{- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}
}{- "requestId": "string",
- "response": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}
}
}Reset venue radio to default values.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string",
- "response": {
- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}
}
}Get the venue radio default values.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "radioParams24G": {
- "allowedChannels": [
- "1"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}, - "radioParams50G": {
- "allowedIndoorChannels": [
- "36"
], - "allowedOutdoorChannels": [
- "36"
], - "changeInterval": 480,
- "channelBandwidth": "AUTO",
- "method": "BACKGROUND_SCANNING",
- "scanInterval": 20,
- "txPower": "MAX"
}
}Get the venue syslog settings.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "enabled": false,
- "facility": "KEEP_ORIGINAL",
- "flowLevel": "CLIENT_FLOW",
- "port": 514,
- "priority": "INFO",
- "protocol": "UDP",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP",
- "secondaryServer": "string",
- "server": "string"
}Update the venue syslog settings.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
Venue Syslog
| enabled | boolean Default: false default: false |
| facility | string Default: "KEEP_ORIGINAL" Enum: "KEEP_ORIGINAL" "LOCAL0" "LOCAL1" "LOCAL2" "LOCAL3" "LOCAL4" "LOCAL5" "LOCAL6" "LOCAL7" default: FacilityEnum.KEEP_ORIGINAL |
| flowLevel | string Default: "CLIENT_FLOW" Enum: "GENERAL_LOGS" "CLIENT_FLOW" "ALL" default: FlowLevelEnum.CLIENT_FLOW |
| port | integer <int32> [ 1 .. 65535 ] Default: 514 default: 514 |
| priority | string Default: "INFO" Enum: "EMERGENCY" "ALERT" "CRITICAL" "ERROR" "WARNING" "NOTICE" "INFO" "ALL" default: PriorityEnum.INFO |
| protocol | string Default: "UDP" Enum: "TCP" "UDP" default: ProtocolEnum.UDP |
| secondaryPort | integer <int32> [ 1 .. 65535 ] Default: 514 default: 514 |
| secondaryProtocol | string Default: "TCP" Enum: "TCP" "UDP" default: ProtocolEnum.TCP |
| secondaryServer | string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(([a-zA-Z]{1})|([a-zA-Z]{1}[a-zA-Z]{1})|([a-zA-Z]{1}[0-9]{1})|([0-9]{1}[a-zA-Z]{1})|([a-zA-Z0-9][a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]))\.([a-zA-Z]{2,6}|[a-zA-Z0-9-]{2,30}\.[a-zA-Z]{2,3})$) |
| server | string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(([a-zA-Z]{1})|([a-zA-Z]{1}[a-zA-Z]{1})|([a-zA-Z]{1}[0-9]{1})|([0-9]{1}[a-zA-Z]{1})|([a-zA-Z0-9][a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]))\.([a-zA-Z]{2,6}|[a-zA-Z0-9-]{2,30}\.[a-zA-Z]{2,3})$) |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "enabled": false,
- "facility": "KEEP_ORIGINAL",
- "flowLevel": "CLIENT_FLOW",
- "port": 514,
- "priority": "INFO",
- "protocol": "UDP",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP",
- "secondaryServer": "string",
- "server": "string"
}{- "requestId": "string",
- "response": {
- "enabled": false,
- "facility": "KEEP_ORIGINAL",
- "flowLevel": "CLIENT_FLOW",
- "port": 514,
- "priority": "INFO",
- "protocol": "UDP",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP",
- "secondaryServer": "string",
- "server": "string"
}
}Reset venue syslog settings to default values.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string",
- "response": {
- "enabled": false,
- "facility": "KEEP_ORIGINAL",
- "flowLevel": "CLIENT_FLOW",
- "port": 514,
- "priority": "INFO",
- "protocol": "UDP",
- "secondaryPort": 514,
- "secondaryProtocol": "TCP",
- "secondaryServer": "string",
- "server": "string"
}
}Get venue default regulatory channels.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "2.4GChannels": {
- "20MHz": [
- "1"
], - "40MHz": [
- "1"
], - "auto": [
- "1"
]
}, - "5GChannels": {
- "indoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}, - "outdoor": {
- "160MHz": [
- "36"
], - "20MHz": [
- "36"
], - "40MHz": [
- "36"
], - "80MHz": [
- "36"
], - "auto": [
- "36"
]
}
}
}Get the vSPoT details of a venue.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "id": "string",
- "password": "stringst",
- "port": 8883,
- "serverAddress": "string",
- "serverName": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vspotGlobalId": "string"
}Unbind a venue from the vSPoT server.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Bind a venue to the vSPoT server.
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
| vspotId required | string vspotId |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string",
- "response": {
- "id": "string",
- "password": "stringst",
- "port": 8883,
- "serverAddress": "string",
- "serverName": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vspotGlobalId": "string"
}
}Get the network list.
| tenantId required | string Tenant ID |
| page | string page |
| size | string size |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "id": "string",
- "name": "string",
- "description": "string",
- "type": "aaa",
- "authRadiusId": "string",
- "accountingRadiusId": "string",
- "wlan": {
- "advancedCustomization": {
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "directedThreshold": 5,
- "enableAaaVlanOverride": true,
- "enableBandBalancing": true,
- "enableFastRoaming": false,
- "enableNeighborReport": true,
- "enableSyslog": false,
- "forceMobileDeviceDhcp": true,
- "hideSsid": false,
- "l2AclEnable": false,
- "l2AclPolicy": {
- "access": "BLOCK",
- "macAddresses": [
- "string"
]
}, - "l3AclEnable": false,
- "l3AclPolicy": {
- "defaultAccess": "ALLOW",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
]
}, - "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "bssMinimumPhyRate": "default",
- "managementFrameMinimumPhyRate": "6",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "BOTH"
}, - "singleSessionIdAccounting": "false",
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "id": "string",
- "name": "string",
- "tenantId": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "ssid": "string",
- "vlanId": 1
}
}
]Create a new network.
| tenantId required | string Tenant ID |
Network
| name required | string (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
| description | string [ 0 .. 255 ] characters |
| type required | string aaa |
| authRadiusId required | string The RADIUS authentication ID |
| accountingRadiusId | string The RADIUS accounting ID |
| wlan required | object (AAAWlan) WLAN |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10100: "PSK passphrase not null when security equals WPAPersonal or WPA2Personal", WIFI-10101: "PSK WepHex key not null when security equals WEP", WIFI-10105: "Invalid Guest Network attributes, When user session timeout is set, the session grace period value must be equal or lower", WIFI-10106: "Only OFDM PHY rates are permitted", WIFI-10107: "When OFDM only is selected, the Management Tx Rate must be greater than or equal to the BSS Minimum Rate", WIFI-10171: "Venue has to activate DHCP Service for Cellular APs"]
Locked
Internal Server Error
USA & North America
Europe
{- "name": "string",
- "description": "string",
- "type": "aaa",
- "authRadiusId": "string",
- "accountingRadiusId": "string",
- "wlan": {
- "advancedCustomization": {
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "directedThreshold": 5,
- "enableAaaVlanOverride": true,
- "enableBandBalancing": true,
- "enableFastRoaming": false,
- "enableNeighborReport": true,
- "enableSyslog": false,
- "forceMobileDeviceDhcp": true,
- "hideSsid": false,
- "l2AclEnable": false,
- "l2AclPolicy": {
- "access": "BLOCK",
- "macAddresses": [
- "string"
]
}, - "l3AclEnable": false,
- "l3AclPolicy": {
- "defaultAccess": "ALLOW",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
]
}, - "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "bssMinimumPhyRate": "default",
- "managementFrameMinimumPhyRate": "6",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "BOTH"
}, - "singleSessionIdAccounting": "false",
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "name": "string",
- "tenantId": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "ssid": "string",
- "vlanId": 1
}
}{- "requestId": "string",
- "response": {
- "id": "string",
- "name": "string",
- "description": "string",
- "type": "aaa",
- "authRadiusId": "string",
- "accountingRadiusId": "string",
- "wlan": {
- "advancedCustomization": {
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "directedThreshold": 5,
- "enableAaaVlanOverride": true,
- "enableBandBalancing": true,
- "enableFastRoaming": false,
- "enableNeighborReport": true,
- "enableSyslog": false,
- "forceMobileDeviceDhcp": true,
- "hideSsid": false,
- "l2AclEnable": false,
- "l2AclPolicy": {
- "access": "BLOCK",
- "macAddresses": [
- "string"
]
}, - "l3AclEnable": false,
- "l3AclPolicy": {
- "defaultAccess": "ALLOW",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
]
}, - "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "bssMinimumPhyRate": "default",
- "managementFrameMinimumPhyRate": "6",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "BOTH"
}, - "singleSessionIdAccounting": "false",
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "id": "string",
- "name": "string",
- "tenantId": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "ssid": "string",
- "vlanId": 1
}
}
}Delete a list of networks.
| tenantId required | string Tenant ID |
List of network IDs
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- "string"
]{- "requestId": "string"
}Create a new network (deep).
| tenantId required | string Tenant ID |
NetworkDeep
| name required | string (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
| description | string [ 0 .. 255 ] characters |
| venues | Array of objects (NetworkVenue) |
| type required | string aaa |
| authRadius required | object (Radius) Primary and secondary RADIUS servers |
| accountingRadius | object (Radius) Primary and secondary RADIUS servers |
| wlan required | object (AAAWlan) WLAN |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10100: "PSK passphrase not null when security equals WPAPersonal or WPA2Personal", WIFI-10101: "PSK WepHex key not null when security equals WEP", WIFI-10105: "Invalid Guest Network attributes, When user session timeout is set, the session grace period value must be equal or lower", WIFI-10106: "Only OFDM PHY rates are permitted", WIFI-10107: "When OFDM only is selected, the Management Tx Rate must be greater than or equal to the BSS Minimum Rate", WIFI-10103: "Port 1813 is not permitted", WIFI-10104: "Port 1812 is not permitted", WIFI-10116: "Invalid External Provider name and region", WIFI-10171: "Venue has to activate DHCP Service for Cellular APs", WIFI-10209: "Invalid social domains"]
Locked
Internal Server Error
USA & North America
Europe
{- "name": "string",
- "description": "string",
- "venues": [
- {
- "allAPGroupsRadio": "Both",
- "allAPGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "isDefault": false,
- "radio": "Both",
- "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActiveted": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "isAllAPGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}
], - "type": "aaa",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "wlan": {
- "advancedCustomization": {
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "directedThreshold": 5,
- "enableAaaVlanOverride": true,
- "enableBandBalancing": true,
- "enableFastRoaming": false,
- "enableNeighborReport": true,
- "enableSyslog": false,
- "forceMobileDeviceDhcp": true,
- "hideSsid": false,
- "l2AclEnable": false,
- "l2AclPolicy": {
- "access": "BLOCK",
- "macAddresses": [
- "string"
]
}, - "l3AclEnable": false,
- "l3AclPolicy": {
- "defaultAccess": "ALLOW",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
]
}, - "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "bssMinimumPhyRate": "default",
- "managementFrameMinimumPhyRate": "6",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "BOTH"
}, - "singleSessionIdAccounting": "false",
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "name": "string",
- "tenantId": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "ssid": "string",
- "vlanId": 1
}
}{- "requestId": "string",
- "response": {
- "id": "string",
- "name": "string",
- "description": "string",
- "venues": [
- {
- "allAPGroupsRadio": "Both",
- "allAPGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "id": "string",
- "isDefault": false,
- "radio": "Both",
- "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActiveted": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "id": "string",
- "isAllAPGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}
], - "type": "aaa",
- "authRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "accountingRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "wlan": {
- "advancedCustomization": {
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "directedThreshold": 5,
- "enableAaaVlanOverride": true,
- "enableBandBalancing": true,
- "enableFastRoaming": false,
- "enableNeighborReport": true,
- "enableSyslog": false,
- "forceMobileDeviceDhcp": true,
- "hideSsid": false,
- "l2AclEnable": false,
- "l2AclPolicy": {
- "access": "BLOCK",
- "macAddresses": [
- "string"
]
}, - "l3AclEnable": false,
- "l3AclPolicy": {
- "defaultAccess": "ALLOW",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
]
}, - "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "bssMinimumPhyRate": "default",
- "managementFrameMinimumPhyRate": "6",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "BOTH"
}, - "singleSessionIdAccounting": "false",
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "id": "string",
- "name": "string",
- "tenantId": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "ssid": "string",
- "vlanId": 1
}
}
}Get the DPSK passphrase format list.
| tenantId required | string Tenant ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "dpskGenerationParams": {
- "passphraseExpirationEnum": "UNLIMITED",
- "passphraseFormatEnum": "MOST_SECURED",
- "passphraseLength": 8
}, - "id": "string",
- "name": "string"
}
]Get the network details.
| tenantId required | string Tenant ID |
| networkId required | string Network ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "id": "string",
- "name": "string",
- "description": "string",
- "type": "aaa",
- "authRadiusId": "string",
- "accountingRadiusId": "string",
- "wlan": {
- "advancedCustomization": {
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "directedThreshold": 5,
- "enableAaaVlanOverride": true,
- "enableBandBalancing": true,
- "enableFastRoaming": false,
- "enableNeighborReport": true,
- "enableSyslog": false,
- "forceMobileDeviceDhcp": true,
- "hideSsid": false,
- "l2AclEnable": false,
- "l2AclPolicy": {
- "access": "BLOCK",
- "macAddresses": [
- "string"
]
}, - "l3AclEnable": false,
- "l3AclPolicy": {
- "defaultAccess": "ALLOW",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
]
}, - "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "bssMinimumPhyRate": "default",
- "managementFrameMinimumPhyRate": "6",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "BOTH"
}, - "singleSessionIdAccounting": "false",
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "id": "string",
- "name": "string",
- "tenantId": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "ssid": "string",
- "vlanId": 1
}
}Update a network.
| tenantId required | string Tenant ID |
| networkId required | string Network ID |
Network
| name required | string (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
| description | string [ 0 .. 255 ] characters |
| type required | string aaa |
| authRadiusId required | string The RADIUS authentication ID |
| accountingRadiusId | string The RADIUS accounting ID |
| wlan required | object (AAAWlan) WLAN |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10100: "PSK passphrase not null when security equals WPAPersonal or WPA2Personal", WIFI-10101: "PSK WepHex key not null when security equals WEP", WIFI-10105: "Invalid Guest Network attributes, When user session timeout is set, the session grace period value must be equal or lower", WIFI-10106: "Only OFDM PHY rates are permitted", WIFI-10107: "When OFDM only is selected, the Management Tx Rate must be greater than or equal to the BSS Minimum Rate", WIFI-10171: "Venue has to activate DHCP Service for Cellular APs"]
Locked
Internal Server Error
USA & North America
Europe
{- "name": "string",
- "description": "string",
- "type": "aaa",
- "authRadiusId": "string",
- "accountingRadiusId": "string",
- "wlan": {
- "advancedCustomization": {
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "directedThreshold": 5,
- "enableAaaVlanOverride": true,
- "enableBandBalancing": true,
- "enableFastRoaming": false,
- "enableNeighborReport": true,
- "enableSyslog": false,
- "forceMobileDeviceDhcp": true,
- "hideSsid": false,
- "l2AclEnable": false,
- "l2AclPolicy": {
- "access": "BLOCK",
- "macAddresses": [
- "string"
]
}, - "l3AclEnable": false,
- "l3AclPolicy": {
- "defaultAccess": "ALLOW",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
]
}, - "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "bssMinimumPhyRate": "default",
- "managementFrameMinimumPhyRate": "6",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "BOTH"
}, - "singleSessionIdAccounting": "false",
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "name": "string",
- "tenantId": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "ssid": "string",
- "vlanId": 1
}
}{- "requestId": "string",
- "response": {
- "id": "string",
- "name": "string",
- "description": "string",
- "type": "aaa",
- "authRadiusId": "string",
- "accountingRadiusId": "string",
- "wlan": {
- "advancedCustomization": {
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "directedThreshold": 5,
- "enableAaaVlanOverride": true,
- "enableBandBalancing": true,
- "enableFastRoaming": false,
- "enableNeighborReport": true,
- "enableSyslog": false,
- "forceMobileDeviceDhcp": true,
- "hideSsid": false,
- "l2AclEnable": false,
- "l2AclPolicy": {
- "access": "BLOCK",
- "macAddresses": [
- "string"
]
}, - "l3AclEnable": false,
- "l3AclPolicy": {
- "defaultAccess": "ALLOW",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
]
}, - "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "bssMinimumPhyRate": "default",
- "managementFrameMinimumPhyRate": "6",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "BOTH"
}, - "singleSessionIdAccounting": "false",
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "id": "string",
- "name": "string",
- "tenantId": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "ssid": "string",
- "vlanId": 1
}
}
}Delete a network.
| tenantId required | string Tenant ID |
| networkId required | string Network ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Get network details, including the nested details.
| tenantId required | string Tenant ID |
| networkId required | string Network ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "id": "string",
- "name": "string",
- "description": "string",
- "venues": [
- {
- "allAPGroupsRadio": "Both",
- "allAPGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "id": "string",
- "isDefault": false,
- "radio": "Both",
- "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActiveted": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "id": "string",
- "isAllAPGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}
], - "type": "aaa",
- "authRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "accountingRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "wlan": {
- "advancedCustomization": {
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "directedThreshold": 5,
- "enableAaaVlanOverride": true,
- "enableBandBalancing": true,
- "enableFastRoaming": false,
- "enableNeighborReport": true,
- "enableSyslog": false,
- "forceMobileDeviceDhcp": true,
- "hideSsid": false,
- "l2AclEnable": false,
- "l2AclPolicy": {
- "access": "BLOCK",
- "macAddresses": [
- "string"
]
}, - "l3AclEnable": false,
- "l3AclPolicy": {
- "defaultAccess": "ALLOW",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
]
}, - "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "bssMinimumPhyRate": "default",
- "managementFrameMinimumPhyRate": "6",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "BOTH"
}, - "singleSessionIdAccounting": "false",
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "id": "string",
- "name": "string",
- "tenantId": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "ssid": "string",
- "vlanId": 1
}
}Update a network
| tenantId required | string Tenant ID |
| networkId required | string Network ID |
NetworkDeep
| name required | string (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
| description | string [ 0 .. 255 ] characters |
| venues | Array of objects (NetworkVenue) |
| type required | string aaa |
| authRadius required | object (Radius) Primary and secondary RADIUS servers |
| accountingRadius | object (Radius) Primary and secondary RADIUS servers |
| wlan required | object (AAAWlan) WLAN |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10100: "PSK passphrase not null when security equals WPAPersonal or WPA2Personal", WIFI-10101: "PSK WepHex key not null when security equals WEP", WIFI-10105: "Invalid Guest Network attributes, When user session timeout is set, the session grace period value must be equal or lower", WIFI-10106: "Only OFDM PHY rates are permitted", WIFI-10107: "When OFDM only is selected, the Management Tx Rate must be greater than or equal to the BSS Minimum Rate", WIFI-10103: "Port 1813 is not permitted", WIFI-10104: "Port 1812 is not permitted", WIFI-10116: "Invalid External Provider name and region", WIFI-10171: "Venue has to activate DHCP Service for Cellular APs", WIFI-10209: "Invalid social domains"]
Locked
Internal Server Error
USA & North America
Europe
{- "name": "string",
- "description": "string",
- "venues": [
- {
- "allAPGroupsRadio": "Both",
- "allAPGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "isDefault": false,
- "radio": "Both",
- "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActiveted": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "isAllAPGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}
], - "type": "aaa",
- "authRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "accountingRadius": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "wlan": {
- "advancedCustomization": {
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "directedThreshold": 5,
- "enableAaaVlanOverride": true,
- "enableBandBalancing": true,
- "enableFastRoaming": false,
- "enableNeighborReport": true,
- "enableSyslog": false,
- "forceMobileDeviceDhcp": true,
- "hideSsid": false,
- "l2AclEnable": false,
- "l2AclPolicy": {
- "access": "BLOCK",
- "macAddresses": [
- "string"
]
}, - "l3AclEnable": false,
- "l3AclPolicy": {
- "defaultAccess": "ALLOW",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
]
}, - "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "bssMinimumPhyRate": "default",
- "managementFrameMinimumPhyRate": "6",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "BOTH"
}, - "singleSessionIdAccounting": "false",
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "name": "string",
- "tenantId": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "ssid": "string",
- "vlanId": 1
}
}{- "requestId": "string",
- "response": {
- "id": "string",
- "name": "string",
- "description": "string",
- "venues": [
- {
- "allAPGroupsRadio": "Both",
- "allAPGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "id": "string",
- "isDefault": false,
- "radio": "Both",
- "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActiveted": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "id": "string",
- "isAllAPGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}
], - "type": "aaa",
- "authRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "accountingRadius": {
- "id": "string",
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "wlan": {
- "advancedCustomization": {
- "clientInactivityTimeout": 120,
- "clientIsolation": false,
- "clientLoadBalancingEnable": true,
- "devicePolicyId": "string",
- "directedThreshold": 5,
- "enableAaaVlanOverride": true,
- "enableBandBalancing": true,
- "enableFastRoaming": false,
- "enableNeighborReport": true,
- "enableSyslog": false,
- "forceMobileDeviceDhcp": true,
- "hideSsid": false,
- "l2AclEnable": false,
- "l2AclPolicy": {
- "access": "BLOCK",
- "macAddresses": [
- "string"
]
}, - "l3AclEnable": false,
- "l3AclPolicy": {
- "defaultAccess": "ALLOW",
- "l3Rules": [
- {
- "access": "ALLOW",
- "customProtocol": 1,
- "description": "string",
- "destination": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}, - "priority": 1,
- "protocol": "L3ProtocolEnum_TCP",
- "source": {
- "enableIpSubnet": false,
- "ip": "string",
- "ipMask": "string",
- "port": "string"
}
}
]
}, - "maxClientsOnWlanPerRadio": 100,
- "mobilityDomainId": 1,
- "radioCustomization": {
- "bssMinimumPhyRate": "default",
- "managementFrameMinimumPhyRate": "6",
- "phyTypeConstraint": "OFDM",
- "rfBandUsage": "BOTH"
}, - "singleSessionIdAccounting": "false",
- "totalDownlinkRateLimiting": 0,
- "totalUplinkRateLimiting": 0,
- "userDownlinkRateLimiting": 0,
- "userUplinkRateLimiting": 0,
- "vlanPool": {
- "description": "string",
- "id": "string",
- "name": "string",
- "tenantId": "string",
- "vlanMembers": [
- "string"
]
}, - "wifiCallingEnabled": false,
- "wifiCallingIds": [
- "string"
]
}, - "bypassCPUsingMacAddressAuthentication": false,
- "enabled": true,
- "ssid": "string",
- "vlanId": 1
}
}
}Create a new network-venue activation.
| tenantId required | string Tenant ID |
Network-Venue
| allAPGroupsRadio | string Default: "Both" Enum: "Both" "2.4-GHz" "5-GHz" default: RadioEnum.Both |
| allAPGroupsVlanId | integer <int32> [ 1 .. 4094 ] |
| apGroups | Array of objects (NetworkAPGroup) |
| isAllAPGroups | boolean Default: true Activate the network on all AP-groups in the venue |
| networkId | string Network ID |
| scheduler | object (NetworkVenueScheduler) Network venue scheduler |
| venueId | string Venue ID |
| vlanPoolId | string |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "allAPGroupsRadio": "Both",
- "allAPGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "isDefault": false,
- "radio": "Both",
- "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActiveted": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "isAllAPGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}{- "requestId": "string",
- "response": {
- "allAPGroupsRadio": "Both",
- "allAPGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "id": "string",
- "isDefault": false,
- "radio": "Both",
- "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActiveted": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "id": "string",
- "isAllAPGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}
}Delete a list of network-venue activations.
| tenantId required | string Tenant ID |
List of network-venue IDs
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- "string"
]{- "requestId": "string"
}Get the network-venue activation details.
| tenantId required | string Tenant ID |
| networkVenueId required | string Network-Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "allAPGroupsRadio": "Both",
- "allAPGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "id": "string",
- "isDefault": false,
- "radio": "Both",
- "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActiveted": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "id": "string",
- "isAllAPGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}Update a network-venue activation.
| tenantId required | string Tenant ID |
| networkVenueId required | string Network-Venue ID |
Network-Venue
| allAPGroupsRadio | string Default: "Both" Enum: "Both" "2.4-GHz" "5-GHz" default: RadioEnum.Both |
| allAPGroupsVlanId | integer <int32> [ 1 .. 4094 ] |
| apGroups | Array of objects (NetworkAPGroup) |
| isAllAPGroups | boolean Default: true Activate the network on all AP-groups in the venue |
| networkId | string Network ID |
| scheduler | object (NetworkVenueScheduler) Network venue scheduler |
| venueId | string Venue ID |
| vlanPoolId | string |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "allAPGroupsRadio": "Both",
- "allAPGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "isDefault": false,
- "radio": "Both",
- "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActiveted": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "isAllAPGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}{- "requestId": "string",
- "response": {
- "allAPGroupsRadio": "Both",
- "allAPGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "id": "string",
- "isDefault": false,
- "radio": "Both",
- "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActiveted": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "id": "string",
- "isAllAPGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}
}Delete a network-venue activation.
| tenantId required | string Tenant ID |
| networkVenueId required | string Network-Venue ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Get network-venue activation list.
| tenantId required | string Tenant ID |
| networkId required | string Network ID |
| page | string page |
| size | string size |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "allAPGroupsRadio": "Both",
- "allAPGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "id": "string",
- "isDefault": false,
- "radio": "Both",
- "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActiveted": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "id": "string",
- "isAllAPGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}
]Get a network-venue activation by network and venue IDs.
| tenantId required | string Tenant ID |
| networkId required | string Network ID |
| venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "allAPGroupsRadio": "Both",
- "allAPGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "id": "string",
- "isDefault": false,
- "radio": "Both",
- "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActiveted": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "id": "string",
- "isAllAPGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}Get venue-network activation list
| tenantId required | string Tenant ID |
| venueId required | string Venue ID |
| page | string page |
| size | string size |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "allAPGroupsRadio": "Both",
- "allAPGroupsVlanId": 1,
- "apGroups": [
- {
- "apGroupId": "string",
- "apGroupName": "string",
- "id": "string",
- "isDefault": false,
- "radio": "Both",
- "validationError": false,
- "validationErrorReachedMaxConnectedCaptiveNetworksLimit": false,
- "validationErrorReachedMaxConnectedNetworksLimit": false,
- "validationErrorSsidAlreadyActiveted": false,
- "vlanId": 1,
- "vlanPoolId": "string",
- "vlanPoolName": "string"
}
], - "id": "string",
- "isAllAPGroups": true,
- "networkId": "string",
- "scheduler": {
- "fri": "string",
- "mon": "string",
- "sat": "string",
- "sun": "string",
- "thu": "string",
- "tue": "string",
- "type": "ALWAYS_ON",
- "wed": "string"
}, - "venueId": "string",
- "vlanPoolId": "string"
}
]Disconnect a list of clients.
| tenantId required | string Tenant ID |
Disconnect client
| apMac required | string The MAC address of the AP |
| clientMac required | string The MAC address of the client |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found [WIFI-10201: "Client not found (may have been previously disconnected)"].
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "apMac": "string",
- "clientMac": "string"
}
]{- "requestId": "string"
}Get the device-policy list.
| tenantId required | string Tenant ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "defaultAccess": "ALLOW",
- "description": "string",
- "id": "string",
- "name": "string",
- "rules": [
- {
- "action": "ALLOW",
- "deviceType": "Laptop",
- "downloadRateLimit": 0,
- "name": "string",
- "osVendor": "All",
- "uploadRateLimit": 0,
- "vlan": 1
}
], - "tenantId": "string"
}
]Create a new device-policy.
| tenantId required | string Tenant ID |
Device-Policy
| defaultAccess | string Enum: "ALLOW" "BLOCK" default: ALLOW |
| description | string [ 2 .. 180 ] characters |
| name required | string [ 2 .. 32 ] characters |
| rules | Array of objects (DevicePolicyRule) |
| tenantId | string |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10203: "Cannot create a Device-Policy rule for "Action" BLOCK, with values being set for "Rate Limit" or "VLAN"", WIFI-10204: "Selected Device-Policy "Device Type" and "OS Vendor" are incompatible", WIFI-10205: "Maximum number of device policies reached", WIFI-10206: "Cannot create more than one rule for the same "Device Type" and "OS Vendor" combination.", WIFI-10207: "Cannot save Device-Policy - rules have none-unique names", WIFI-10208: "There can only be a single rule for a "Device Type" if "OS Vendor" equals ALL"]
Locked
Internal Server Error
USA & North America
Europe
{- "defaultAccess": "ALLOW",
- "description": "string",
- "name": "string",
- "rules": [
- {
- "action": "ALLOW",
- "deviceType": "Laptop",
- "downloadRateLimit": 0,
- "name": "string",
- "osVendor": "All",
- "uploadRateLimit": 0,
- "vlan": 1
}
], - "tenantId": "string"
}{- "requestId": "string",
- "response": {
- "defaultAccess": "ALLOW",
- "description": "string",
- "id": "string",
- "name": "string",
- "rules": [
- {
- "action": "ALLOW",
- "deviceType": "Laptop",
- "downloadRateLimit": 0,
- "name": "string",
- "osVendor": "All",
- "uploadRateLimit": 0,
- "vlan": 1
}
], - "tenantId": "string"
}
}Delete a list of device-policies.
| tenantId required | string Tenant ID |
List of device-policy IDs
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- "string"
]{- "requestId": "string"
}Get the device-policy details.
| tenantId required | string Tenant ID |
| devicePolicyId required | string Device-policy ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "defaultAccess": "ALLOW",
- "description": "string",
- "id": "string",
- "name": "string",
- "rules": [
- {
- "action": "ALLOW",
- "deviceType": "Laptop",
- "downloadRateLimit": 0,
- "name": "string",
- "osVendor": "All",
- "uploadRateLimit": 0,
- "vlan": 1
}
], - "tenantId": "string"
}Update a device-policy.
| tenantId required | string Tenant ID |
| devicePolicyId required | string Device-policy ID |
Device-policy
| defaultAccess | string Enum: "ALLOW" "BLOCK" default: ALLOW |
| description | string [ 2 .. 180 ] characters |
| name required | string [ 2 .. 32 ] characters |
| rules | Array of objects (DevicePolicyRule) |
| tenantId | string |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10203: "Cannot create a Device-Policy rule for "Action" BLOCK, with values being set for "Rate Limit" or "VLAN"", WIFI-10204: "Selected Device-Policy "Device Type" and "OS Vendor" are incompatible", WIFI-10206: "Cannot create more than one rule for the same "Device Type" and "OS Vendor" combination.", WIFI-10207: "Cannot save Device-Policy - rules have none-unique names", WIFI-10208: "There can only be a single rule for a "Device Type" if "OS Vendor" equals ALL"]
Locked
Internal Server Error
USA & North America
Europe
{- "defaultAccess": "ALLOW",
- "description": "string",
- "name": "string",
- "rules": [
- {
- "action": "ALLOW",
- "deviceType": "Laptop",
- "downloadRateLimit": 0,
- "name": "string",
- "osVendor": "All",
- "uploadRateLimit": 0,
- "vlan": 1
}
], - "tenantId": "string"
}{- "requestId": "string",
- "response": {
- "defaultAccess": "ALLOW",
- "description": "string",
- "id": "string",
- "name": "string",
- "rules": [
- {
- "action": "ALLOW",
- "deviceType": "Laptop",
- "downloadRateLimit": 0,
- "name": "string",
- "osVendor": "All",
- "uploadRateLimit": 0,
- "vlan": 1
}
], - "tenantId": "string"
}
}Delete a device-policy.
| tenantId required | string Tenant ID |
| devicePolicyId required | string Device-policy ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Get list of DHCP service-profiles.
| tenantId required | string Tenant ID |
| excludeDefault | string Default: "true" excludeDefault |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "endIpAddress": "string",
- "id": "string",
- "leaseTimeHours": 0,
- "leaseTimeMinutes": 0,
- "name": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "startIpAddress": "string",
- "subnetAddress": "string",
- "subnetMask": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vlanId": 1
}
]Create a new DHCP service-profile.
| tenantId required | string Tenant ID |
DHCP Service-Profile
| endIpAddress required | string ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ |
| leaseTimeHours required | integer <int32> [ 0 .. 24 ] |
| leaseTimeMinutes required | integer <int32> [ 0 .. 59 ] |
| name required | string [ 2 .. 32 ] characters ^[!-~]([ -~])*[!-~]$ |
| primaryDnsIp | string ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ |
| secondaryDnsIp | string ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ |
| startIpAddress required | string ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ |
| subnetAddress required | string ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ |
| subnetMask required | string ^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128|0+))|(?:(?:255\.){2}(?:255|254|252|248|240|224|192|128|0+)\.0)|(?:(?:255\.)(?:255|254|252|248|240|224|192|128|0+)(?:\.0+){2})|(?:(?:255|254|252|248|240|224|192|128|0+)(?:\.0+){3}))$ |
| venues | Array of objects (IdAndName) |
| vlanId required | integer <int32> [ 1 .. 4094 ] |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "endIpAddress": "string",
- "leaseTimeHours": 0,
- "leaseTimeMinutes": 0,
- "name": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "startIpAddress": "string",
- "subnetAddress": "string",
- "subnetMask": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vlanId": 1
}{- "requestId": "string",
- "response": {
- "endIpAddress": "string",
- "id": "string",
- "leaseTimeHours": 0,
- "leaseTimeMinutes": 0,
- "name": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "startIpAddress": "string",
- "subnetAddress": "string",
- "subnetMask": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vlanId": 1
}
}Delete a list of DHCP service-profiles.
| tenantId required | string Tenant ID |
| force | string Default: "false" force |
List of DHCP service-profile IDs
OK
Accepted
Bad/malformed request [WIFI-10153: "Default DHCP Service Profile is not allowed to be deleted", WIFI-10156: "Some DHCP Service Profiles cannot be deleted which are used by some Venues"]
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- "string"
]{- "requestId": "string"
}Get the DHCP service-profile details.
| tenantId required | string Tenant ID |
| dhcpServiceProfileId required | string DHCP Service-Profile ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "endIpAddress": "string",
- "id": "string",
- "leaseTimeHours": 0,
- "leaseTimeMinutes": 0,
- "name": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "startIpAddress": "string",
- "subnetAddress": "string",
- "subnetMask": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vlanId": 1
}Update a DHCP service-profile.
| tenantId required | string Tenant ID |
| dhcpServiceProfileId required | string DHCP Service-Profile ID |
DHCP Service-Profile
| endIpAddress required | string ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ |
| leaseTimeHours required | integer <int32> [ 0 .. 24 ] |
| leaseTimeMinutes required | integer <int32> [ 0 .. 59 ] |
| name required | string [ 2 .. 32 ] characters ^[!-~]([ -~])*[!-~]$ |
| primaryDnsIp | string ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ |
| secondaryDnsIp | string ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ |
| startIpAddress required | string ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ |
| subnetAddress required | string ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ |
| subnetMask required | string ^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128|0+))|(?:(?:255\.){2}(?:255|254|252|248|240|224|192|128|0+)\.0)|(?:(?:255\.)(?:255|254|252|248|240|224|192|128|0+)(?:\.0+){2})|(?:(?:255|254|252|248|240|224|192|128|0+)(?:\.0+){3}))$ |
| venues | Array of objects (IdAndName) |
| vlanId required | integer <int32> [ 1 .. 4094 ] |
OK
Accepted
Bad/malformed request [WIFI-10154: "The name of default DHCP Service Profile is not allowed to be modified"]
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10171: "Venue has to activate DHCP Service for Cellular APs"]
Locked
Internal Server Error
USA & North America
Europe
{- "endIpAddress": "string",
- "leaseTimeHours": 0,
- "leaseTimeMinutes": 0,
- "name": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "startIpAddress": "string",
- "subnetAddress": "string",
- "subnetMask": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vlanId": 1
}{- "requestId": "string",
- "response": {
- "endIpAddress": "string",
- "id": "string",
- "leaseTimeHours": 0,
- "leaseTimeMinutes": 0,
- "name": "string",
- "primaryDnsIp": "string",
- "secondaryDnsIp": "string",
- "startIpAddress": "string",
- "subnetAddress": "string",
- "subnetMask": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vlanId": 1
}
}Delete a DHCP service-profile.
| tenantId required | string Tenant ID |
| dhcpServiceProfileId required | string DHCP Service-Profile ID |
| force | string Default: "false" force |
OK
Accepted
Bad/malformed request [WIFI-10153: "Default DHCP Service Profile is not allowed to be deleted", WIFI-10155: "The DHCP Service Profile cannot be deleted which is used by some Venues"]
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Get the list of venues bound with the DHCP service-profile.
| tenantId required | string Tenant ID |
| dhcpServiceProfileId required | string DHCP service-profile ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "dhcpServiceProfileId": "string",
- "venueId": "string"
}
]Bind a DHCP service-profile with venues.
| tenantId required | string Tenant ID |
| dhcpServiceProfileId required | string DHCP Service-Profile ID |
List of venue IDs
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- "string"
]{- "requestId": "string",
- "response": [
- {
- "dhcpServiceProfileId": "string",
- "venueId": "string"
}
]
}Unbind a DHCP service-profile from venues.
| tenantId required | string Tenant ID |
| dhcpServiceProfileId required | string DHCP Service-Profile ID |
List of venue IDs
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- "string"
]{- "requestId": "string"
}Create new DPSK passphrase(s).
| tenantId required | string Tenant ID |
DPSK Passphrase
| expiration | integer <int64> |
| mac required | string ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$|^([0-9A-Fa-f]{12})$ |
| networkId | string Network ID |
| override | boolean Default: false True if overriding |
| passphrase | string [ 8 .. 63 ] characters |
| username | string [ 0 .. 200 ] characters |
| vlanId | integer <int32> [ 1 .. 4094 ] Default: 1 VLAN ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error [WIFI-10102: "DPSK passphrase not null when security equals WPAPersonal or WPA2Personal"]
Locked
Internal Server Error
USA & North America
Europe
{- "expiration": 0,
- "mac": "string",
- "networkId": "string",
- "override": false,
- "passphrase": "stringst",
- "username": "string",
- "vlanId": 1
}{- "requestId": "string",
- "response": {
- "expiration": 0,
- "id": "string",
- "mac": "string",
- "networkId": "string",
- "override": false,
- "passphrase": "stringst",
- "username": "string",
- "vlanId": 1
}
}Delete a list of DPSK passphrases.
| tenantId required | string Tenant ID |
List of DPSK passphrase IDs
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- "string"
]{- "requestId": "string"
}Get the guest-users list.
| tenantId required | string Tenant ID |
| page | string Default: "1" page |
| size | string Default: "50" size |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "content": [
- {
- "createdDate": 0,
- "deliveryMethods": [
- "MAIL"
], - "disabled": false,
- "email": "string",
- "expiration": {
- "activationType": "Creation",
- "duration": 0,
- "unit": "Minute"
}, - "expirationDate": 0,
- "guestUserType": "GuestPass",
- "id": "string",
- "lastModified": 0,
- "macAddresses": [
- "string"
], - "maxDevices": 3,
- "mobilePhoneNumber": "string",
- "name": "string",
- "networkId": "string",
- "notes": "string",
- "password": "string",
- "ssid": "string"
}
], - "totalElements": 0
}Create a list of new guest-users.
| tenantId required | string tenantId |
guestsPayload
| deliveryMethods required | Array of strings Items Enum: "MAIL" "SMS" "STUB" "PRINT" At least one |
| disabled | boolean |
string The email of the guest-user | |
| expiration required | object (GuestUserExpiration) |
| maxDevices required | integer <int32> Maximum number of devices on which the guest pass can be used simultaneously. Set to -1 for unlimited number of devices. |
| mobilePhoneNumber required | string The mobile number of the guest-user |
| name required | string The name of the guest-user |
| networkId required | string The network that the guest-user can connect to |
| notes | string [ 0 .. 180 ] characters |
Created
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "deliveryMethods": [
- "MAIL"
], - "disabled": false,
- "email": "string",
- "expiration": {
- "activationType": "Creation",
- "duration": 0,
- "unit": "Minute"
}, - "maxDevices": 3,
- "mobilePhoneNumber": "string",
- "name": "string",
- "networkId": "string",
- "notes": "string"
}
]{- "requestId": "string",
- "response": [
- {
- "createdDate": 0,
- "deliveryMethods": [
- "MAIL"
], - "disabled": false,
- "email": "string",
- "expiration": {
- "activationType": "Creation",
- "duration": 0,
- "unit": "Minute"
}, - "expirationDate": 0,
- "guestUserType": "GuestPass",
- "id": "string",
- "lastModified": 0,
- "macAddresses": [
- "string"
], - "maxDevices": 3,
- "mobilePhoneNumber": "string",
- "name": "string",
- "networkId": "string",
- "notes": "string",
- "password": "string",
- "ssid": "string"
}
]
}Delete a list of guest-users.
| tenantId required | string Tenant ID |
List of guest-user IDs
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- "string"
]{- "requestId": "string"
}Import list of new guest-users from a file.
| tenantId required | string Tenant ID |
| networkId required | string Network ID |
| deliveryMethods | Array of strings Items Enum: "MAIL" "SMS" "STUB" "PRINT" deliveryMethods |
| expiration.activationType required | string Enum: "Creation" "Login" expiration.activationType |
| expiration.duration required | integer <int32> [ 1 .. 8760 ] expiration.duration |
| expiration.unit required | string Enum: "Minute" "Hour" "Day" "Week" "Month" "Year" "Never" expiration.unit |
| maxDevices required | integer <int32> maxDevices |
| file required | string <binary> file |
Created
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string",
- "response": {
- "data": [
- {
- "createdDate": 0,
- "deliveryMethods": [
- "MAIL"
], - "disabled": false,
- "email": "string",
- "expiration": {
- "activationType": "Creation",
- "duration": 0,
- "unit": "Minute"
}, - "expirationDate": 0,
- "guestUserType": "GuestPass",
- "id": "string",
- "lastModified": 0,
- "macAddresses": [
- "string"
], - "maxDevices": 3,
- "mobilePhoneNumber": "string",
- "name": "string",
- "networkId": "string",
- "notes": "string",
- "password": "string",
- "ssid": "string"
}
], - "downloadUrl": "string"
}
}Get the guest-user details.
| tenantId required | string Tenant ID |
| guestUserId required | string The guest-user ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "createdDate": 0,
- "deliveryMethods": [
- "MAIL"
], - "disabled": false,
- "email": "string",
- "expiration": {
- "activationType": "Creation",
- "duration": 0,
- "unit": "Minute"
}, - "expirationDate": 0,
- "guestUserType": "GuestPass",
- "id": "string",
- "lastModified": 0,
- "macAddresses": [
- "string"
], - "maxDevices": 3,
- "mobilePhoneNumber": "string",
- "name": "string",
- "networkId": "string",
- "notes": "string",
- "password": "string",
- "ssid": "string"
}Delete a guest-user.
| tenantId required | string Tenant ID |
| guestUserId required | string Guest-user ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Disable a guest-user
| tenantId required | string Tenant ID |
| guestUserId required | string Guest-user ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Enable a guest-user.
| tenantId required | string Tenant ID |
| guestUserId required | string Guest-user ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Regenerate a guest-user credentials.
| tenantId required | string Tenant ID |
| guestUserId required | string Guest-user ID |
Delivery Methods
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- "MAIL"
]{- "requestId": "string",
- "response": {
- "createdDate": 0,
- "deliveryMethods": [
- "MAIL"
], - "disabled": false,
- "email": "string",
- "expiration": {
- "activationType": "Creation",
- "duration": 0,
- "unit": "Minute"
}, - "expirationDate": 0,
- "guestUserType": "GuestPass",
- "id": "string",
- "lastModified": 0,
- "macAddresses": [
- "string"
], - "maxDevices": 3,
- "mobilePhoneNumber": "string",
- "name": "string",
- "networkId": "string",
- "notes": "string",
- "password": "string",
- "ssid": "string"
}
}Get the PSK for the recovery network.
| tenantId required | string Tenant ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "psk": "string",
- "tenantId": "string"
}Update the PSK for the recovery network.
| tenantId required | string Tenant ID |
Recovery PSK
| psk | string ^([0-9]{4}){4}$ |
| tenantId | string |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "psk": "string",
- "tenantId": "string"
}{- "requestId": "string",
- "response": {
- "psk": "string",
- "tenantId": "string"
}
}Get the vSPoT server list.
| tenantId required | string Tenant ID |
| page | string page |
| size | string size |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "id": "string",
- "password": "stringst",
- "port": 8883,
- "serverAddress": "string",
- "serverName": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vspotGlobalId": "string"
}
]Create a new vSPoT server.
| tenantId required | string Tenant ID |
vSPOT
| password required | string [ 8 .. 63 ] characters ^(?!(`|\$))[!-~]{8,63}$ |
| port | integer <int32> [ 1 .. 65535 ] Default: 8883 default: 8883 |
| serverAddress required | string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(([a-zA-Z]{1})|([a-zA-Z]{1}[a-zA-Z]{1})|([a-zA-Z]{1}[0-9]{1})|([0-9]{1}[a-zA-Z]{1})|([a-zA-Z0-9][a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]))\.([a-zA-Z]{2,6}|[a-zA-Z0-9-]{2,30}\.[a-zA-Z]{2,3})$) |
| serverName required | string (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
| venues | Array of objects (IdAndName) |
| vspotGlobalId | string The vSPoT global ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "password": "stringst",
- "port": 8883,
- "serverAddress": "string",
- "serverName": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vspotGlobalId": "string"
}{- "requestId": "string",
- "response": {
- "id": "string",
- "password": "stringst",
- "port": 8883,
- "serverAddress": "string",
- "serverName": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vspotGlobalId": "string"
}
}Get the vSPoT server details.
| tenantId required | string Tenant ID |
| vspotId required | string vspotId |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "id": "string",
- "password": "stringst",
- "port": 8883,
- "serverAddress": "string",
- "serverName": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vspotGlobalId": "string"
}Update a vSPoT server.
| tenantId required | string Tenant ID |
| vspotId required | string vspotId |
vSPOT
| password required | string [ 8 .. 63 ] characters ^(?!(`|\$))[!-~]{8,63}$ |
| port | integer <int32> [ 1 .. 65535 ] Default: 8883 default: 8883 |
| serverAddress required | string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(([a-zA-Z]{1})|([a-zA-Z]{1}[a-zA-Z]{1})|([a-zA-Z]{1}[0-9]{1})|([0-9]{1}[a-zA-Z]{1})|([a-zA-Z0-9][a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]))\.([a-zA-Z]{2,6}|[a-zA-Z0-9-]{2,30}\.[a-zA-Z]{2,3})$) |
| serverName required | string (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
| venues | Array of objects (IdAndName) |
| vspotGlobalId | string The vSPoT global ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "password": "stringst",
- "port": 8883,
- "serverAddress": "string",
- "serverName": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vspotGlobalId": "string"
}{- "requestId": "string",
- "response": {
- "id": "string",
- "password": "stringst",
- "port": 8883,
- "serverAddress": "string",
- "serverName": "string",
- "venues": [
- {
- "id": "string",
- "name": "string"
}
], - "vspotGlobalId": "string"
}
}Delete a vSPoT server.
| tenantId required | string Tenant ID |
| vspotId required | string vspotId |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}Get the Wi-Fi Calling profiles.
| tenantId required | string Tenant ID |
| page | string page |
| size | string size |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- {
- "description": "string",
- "ePDGs": [
- {
- "domain": "string",
- "ip": "string"
}
], - "id": "string",
- "profileName": "string",
- "qosPriority": "WIFICALLING_PRI_VOICE"
}
]Create a new Wi-Fi Calling profile.
| tenantId required | string Tenant ID |
Wi-Fi Calling Profile
| description | string [ 2 .. 180 ] characters |
| ePDGs required | Array of objects (Epdg) |
| profileName required | string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
| qosPriority | string Default: "WIFICALLING_PRI_VOICE" Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG" default: QosPriorityEnum.WIFICALLING_PRI_VOICE |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "description": "string",
- "ePDGs": [
- {
- "domain": "string",
- "ip": "string"
}
], - "profileName": "string",
- "qosPriority": "WIFICALLING_PRI_VOICE"
}{- "requestId": "string",
- "response": {
- "description": "string",
- "ePDGs": [
- {
- "domain": "string",
- "ip": "string"
}
], - "id": "string",
- "profileName": "string",
- "qosPriority": "WIFICALLING_PRI_VOICE"
}
}Delete a list of Wi-Fi Calling profiles.
| tenantId required | string Tenant ID |
List of Wi-Fi Calling profile IDs
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
[- "string"
]{- "requestId": "string"
}Get the Wi-Fi Calling profile details.
| tenantId required | string Tenant ID |
| wifiCallingProfileId required | string Wi-Fi calling profile ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "description": "string",
- "ePDGs": [
- {
- "domain": "string",
- "ip": "string"
}
], - "id": "string",
- "profileName": "string",
- "qosPriority": "WIFICALLING_PRI_VOICE"
}Update a Wi-Fi Calling profile.
| tenantId required | string Tenant ID |
| wifiCallingProfileId required | string Wi-Fi calling profile ID |
Wi-Fi Calling Profile
| description | string [ 2 .. 180 ] characters |
| ePDGs required | Array of objects (Epdg) |
| profileName required | string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$ |
| qosPriority | string Default: "WIFICALLING_PRI_VOICE" Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG" default: QosPriorityEnum.WIFICALLING_PRI_VOICE |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "description": "string",
- "ePDGs": [
- {
- "domain": "string",
- "ip": "string"
}
], - "profileName": "string",
- "qosPriority": "WIFICALLING_PRI_VOICE"
}{- "requestId": "string",
- "response": {
- "description": "string",
- "ePDGs": [
- {
- "domain": "string",
- "ip": "string"
}
], - "id": "string",
- "profileName": "string",
- "qosPriority": "WIFICALLING_PRI_VOICE"
}
}Delete a Wi-Fi Calling profile.
| tenantId required | string Tenant ID |
| wifiCallingProfileId required | string Wi-Fi calling profile ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
USA & North America
Europe
{- "requestId": "string"
}