Wi-Fi API and Model Documentation (0.3.435)

Wi-Fi API and Model Documentation

DPSK Authentication Credentials

Manage DPSK passphrases.

Delete DPSK Passphrases

Delete a list of DPSK passphrases.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Update DPSK Passphrases (Revoke, Unrevoke)

Update a list of DPSK passphrases.

Request Body schema: application/json
Array of objects (SimpleJsonPatch)
ids
Array of strings
updateState
string
Enum: "REVOKE" "UNREVOKE"

Responses

Request samples

Content type
application/json
{
  • "dpskPassphrasePatch": [
    ],
  • "ids": [
    ],
  • "updateState": "REVOKE"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Create DPSK Passphrases

Create one or more DPSK passphrases.

Request Body schema: application/json
email
string [ 0 .. 255 ] characters ^$|^[_a-zA-Z0-9-]+(\.[_a-zA-Z0-9-]+)*@[a-zA-Z...
expiration
string
mac
string^([0-9A-Fa-f]{2}[.:-]){5}([0-9A-Fa-f]{2})$|^(...
numberOfDevices
integer <int32> [ 1 .. 50 ]
Default: 1
numberOfDevicesType
string
Default: "DpskNumberOfDevicesEnum.LIMITED"
Enum: "LIMITED" "UNLIMITED"
numberOfPassphrases
integer <int32> [ 1 .. 5000 ]
Default: 1
override
boolean
Default: false
passphrase
string [ 8 .. 63 ] characters ^[ -~]{8,63}$
phoneNumber
string [ 0 .. 16 ] characters
revocationDate
string <date-time>
revocationReason
string
username
string [ 0 .. 190 ] characters
vlanId
integer <int32> [ 1 .. 4094 ]

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "expiration": "string",
  • "mac": "string",
  • "numberOfDevices": 1,
  • "numberOfDevicesType": "LIMITED",
  • "numberOfPassphrases": 1,
  • "override": false,
  • "passphrase": "stringst",
  • "phoneNumber": "string",
  • "revocationDate": "2019-08-24T14:15:22Z",
  • "revocationReason": "string",
  • "username": "string",
  • "vlanId": 1
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Query DPSK Passphrases

Query for a list of DPSK passphrases.

Request Body schema: application/json
fields
Array of strings
object (DpskPassphraseFilters)

Filters used to query DPSK passphrase.

page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "filters": {
    },
  • "page": 1,
  • "pageSize": 25,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "fields": [
    ],
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Export DPSK Passphrases

Export all the unexpired DPSK passphrases in the database in a CSV-formatted file.

query Parameters
timezone
string
Default: "UTC"
date-format
string
Default: "dd/MM/yyyy HH:mm"
Request Body schema: application/json
object (DpskPassphraseFilters)

Filters used to query DPSK passphrase.

searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
application/json
{
  • "downloadUrl": "string",
  • "errors": [
    ],
  • "requestId": "string"
}

Delete DPSK Passphrase

Delete this DPSK passphrase.

path Parameters
dpskPassphraseId
required
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Wi-Fi Calling

Manage Wi-Fi calling profiles.

Delete Wi-Fi Calling Profiles

Delete a list of Wi-Fi calling profiles.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Wi-Fi Calling Profiles

Get the Wi-Fi calling profiles.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Wi-Fi Calling Profile

Create a new Wi-Fi calling profile.

Request Body schema: application/json
description
string [ 2 .. 180 ] characters
required
Array of objects (Epdg) [ 1 .. 5 ] items
profileName
required
string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
qosPriority
string
Default: "QosPriorityEnum.WIFICALLING_PRI_VOICE"
Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG"

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "ePDGs": [
    ],
  • "profileName": "string",
  • "qosPriority": "WIFICALLING_PRI_VOICE"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Delete Wi-Fi Calling Profile

Delete a Wi-Fi calling profile.

path Parameters
wifiCallingProfileId
required
string

Wi-Fi calling profile ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Wi-Fi Calling Profile

Get the Wi-Fi calling profile details.

path Parameters
wifiCallingProfileId
required
string

Wi-Fi calling profile ID

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "ePDGs": [
    ],
  • "id": "string",
  • "profileName": "string",
  • "qosPriority": "WIFICALLING_PRI_VOICE"
}

Update Wi-Fi Calling Profile

Update a Wi-Fi calling profile.

path Parameters
wifiCallingProfileId
required
string

Wi-Fi calling profile ID

Request Body schema: application/json
description
string [ 2 .. 180 ] characters
required
Array of objects (Epdg) [ 1 .. 5 ] items
profileName
required
string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
qosPriority
string
Default: "QosPriorityEnum.WIFICALLING_PRI_VOICE"
Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG"

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "ePDGs": [
    ],
  • "profileName": "string",
  • "qosPriority": "WIFICALLING_PRI_VOICE"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Network

Manage network profiles.

Delete Networks

Delete a list of networks.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Networks

Get the network list.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Network

Create a new network.

Request Body schema: application/json
One of
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
type
required
string
object (Radius)

Primary and secondary radius servers.

accountingRadiusId
string
Deprecated
object (Radius)

Primary and secondary radius servers.

authRadiusId
string
Deprecated
cloudpathServerId
string
description
string [ 0 .. 255 ] characters
enableAccountingProxy
boolean
Default: false
enableAuthProxy
boolean
Default: false
required
object (AAAWlan)

WLAN

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "type": "string",
  • "accountingRadius": {
    },
  • "accountingRadiusId": "string",
  • "authRadius": {
    },
  • "authRadiusId": "string",
  • "cloudpathServerId": "string",
  • "description": "string",
  • "enableAccountingProxy": false,
  • "enableAuthProxy": false,
  • "wlan": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get DPSK Passphrase Formats

Get the DPSK passphrase format list.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get External WISPr Providers

Get the list of external WISPr providers for a captive portal network. Note: these providers have integrated their service with the RUCKUS cloud.

Responses

Response samples

Content type
application/json
{
  • "providers": [
    ]
}

Delete Network

Delete a network.

path Parameters
networkId
required
string

Network ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Network

Get the network details.

path Parameters
networkId
required
string

Network ID

query Parameters
deep
boolean
Default: false

Get deep details of this network.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "name": "string",
  • "type": "AAANetwork",
  • "accountingRadius": {
    },
  • "accountingRadiusId": "string",
  • "authRadius": {
    },
  • "authRadiusId": "string",
  • "cloudpathServerId": "string",
  • "description": "string",
  • "enableAccountingProxy": false,
  • "enableAuthProxy": false,
  • "tenantId": "string",
  • "venues": [
    ],
  • "wlan": {
    }
}

Update Network

Update this network, including nested details.

path Parameters
networkId
required
string

Network ID

Request Body schema: application/json
One of
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
type
required
string
object (Radius)

Primary and secondary radius servers.

accountingRadiusId
string
Deprecated
object (Radius)

Primary and secondary radius servers.

authRadiusId
string
Deprecated
cloudpathServerId
string
description
string [ 0 .. 255 ] characters
enableAccountingProxy
boolean
Default: false
enableAuthProxy
boolean
Default: false
required
object (AAAWlan)

WLAN

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "type": "string",
  • "accountingRadius": {
    },
  • "accountingRadiusId": "string",
  • "authRadius": {
    },
  • "authRadiusId": "string",
  • "cloudpathServerId": "string",
  • "description": "string",
  • "enableAccountingProxy": false,
  • "enableAuthProxy": false,
  • "wlan": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Validate X509 Certificates

Validate the x509 certificate chain issued by a trusted certificate authority.

Request Body schema: application/json
info
string
Array of objects (X509Certificate)
required
object (X509Certificate)

X509 certificate

Responses

Request samples

Content type
application/json
{
  • "info": "string",
  • "interCerts": [
    ],
  • "rootCert": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

DHCP Service-Venue

Manage assignments of DHCP service profiles to venues.

Unbind DHCP Service-Profile Venues

Unbind a DHCP service-profile from venues.

path Parameters
dhcpServiceProfileId
required
string

DHCP Service-Profile ID

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get DHCP Venue Bindings

Get the list of venues bound with the DHCP service-profile.

path Parameters
dhcpServiceProfileId
required
string

DHCP Service-Profile ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bind DHCP Service-Profile Venues

Bind a DHCP service-profile with venues.

path Parameters
dhcpServiceProfileId
required
string

DHCP Service-Profile ID

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Venue DHCP Profiles

Get the venue DHCP service profiles.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Venue DHCP Activation

Update the venue DHCP service profile bound to venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Unbind Venue DHCP Service-Profile

Unbind a venue from a DHCP service-profile.

path Parameters
venueId
required
string

Venue ID

dhcpServiceProfileId
required
string

DHCP Service-Profile ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Bind Venue DHCP Service-Profile

Bind a venue with a DHCP service-profile.

path Parameters
venueId
required
string

Venue ID

dhcpServiceProfileId
required
string

DHCP Service-Profile ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Cloudpath

Manage Cloudpath service.

Delete Cloudpath Servers

Delete a list of Cloudpath servers.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Cloudpath Servers

Get a list of Cloudpath servers.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Cloudpath Server

Add a new Cloudpath server.

Request Body schema: application/json
object (Radius)

Primary and secondary radius servers.

required
object (Radius)

Primary and secondary radius servers.

deployedInVenueId
string
deployedInVenueName
string
deploymentType
string
Default: "CloudpathDeploymentTypeEnum.OnPremise"
Enum: "OnPremise" "Cloud"
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
object (ApPosition)

AP position object

Responses

Request samples

Content type
application/json
{
  • "accountingRadius": {
    },
  • "authRadius": {
    },
  • "deployedInVenueId": "string",
  • "deployedInVenueName": "string",
  • "deploymentType": "OnPremise",
  • "name": "string",
  • "position": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Delete Cloudpath Server

Delete this Cloudpath server.

path Parameters
cloudpathServerId
required
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Cloudpath Server

Get details for this Cloudpath server.

path Parameters
cloudpathServerId
required
string

Responses

Response samples

Content type
application/json
{
  • "accountingRadius": {
    },
  • "authRadius": {
    },
  • "deployedInVenueId": "string",
  • "deployedInVenueName": "string",
  • "deploymentType": "OnPremise",
  • "id": "string",
  • "name": "string",
  • "position": {
    }
}

Trigger Cloudpath Server Action

Test the connection to this Cloudpath server. Note: for on-premise deployments, the network using the Cloudpath server must be activated on the venue for this command to work properly.

path Parameters
cloudpathServerId
required
string
Request Body schema: application/json
action
required
string
Value: "testConnection"

Responses

Request samples

Content type
application/json
{
  • "action": "testConnection"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Update Cloudpath Server

Update the configuration of this Cloudpath server.

path Parameters
cloudpathServerId
required
string
Request Body schema: application/json
object (Radius)

Primary and secondary radius servers.

required
object (Radius)

Primary and secondary radius servers.

deployedInVenueId
string
deployedInVenueName
string
deploymentType
string
Default: "CloudpathDeploymentTypeEnum.OnPremise"
Enum: "OnPremise" "Cloud"
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
object (ApPosition)

AP position object

Responses

Request samples

Content type
application/json
{
  • "accountingRadius": {
    },
  • "authRadius": {
    },
  • "deployedInVenueId": "string",
  • "deployedInVenueName": "string",
  • "deploymentType": "OnPremise",
  • "name": "string",
  • "position": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Update Cloudpath Server Position

Update Cloudpath server floor-plan position.

path Parameters
cloudpathServerId
required
string

Cloudpath Server Id

Request Body schema: application/json
floorplanId
string
xPercent
number <float> [ 0 .. 100 ]
Default: 0
yPercent
number <float> [ 0 .. 100 ]
Default: 0

Responses

Request samples

Content type
application/json
{
  • "floorplanId": "string",
  • "xPercent": 0,
  • "yPercent": 0
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

L2ACL Policy

Manage layer-2 ACL policy profiles.

Delete Layer-2 ACL Profiles

Delete layer-2 ACL profiles.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Layer-2 ACL Profiles

Get layer-2 ACL profile collection.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Layer-2 ACL

Add layer-2 ACL by profile.

Request Body schema: application/json
access
string
Default: "AccessEnum.BLOCK"
Enum: "ALLOW" "BLOCK"
description
string
macAddresses
required
Array of strings [ 1 .. 128 ] items
name
required
string [ 2 .. 32 ] characters

Responses

Request samples

Content type
application/json
{
  • "access": "ALLOW",
  • "description": "string",
  • "macAddresses": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Query Layer-2 ACL

Query layer-2 ACL profile.

Request Body schema: application/json
fields
Array of strings
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "page": 1,
  • "pageSize": 25,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "fields": [
    ],
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Layer-2 ACL

Delete layer-2 ACL by profile id.

path Parameters
l2AclPolicyId
required
string

L2Acl Policy ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Layer-2 ACL

Get layer-2 ACL by profile id.

path Parameters
l2AclPolicyId
required
string

L2Acl Policy ID

Responses

Response samples

Content type
application/json
{
  • "access": "ALLOW",
  • "description": "string",
  • "id": "string",
  • "macAddresses": [
    ],
  • "name": "string"
}

Update Layer-2 ACL

Update layer-2 ACL by profile id.

path Parameters
l2AclPolicyId
required
string

L2Acl Policy ID

Request Body schema: application/json
access
string
Default: "AccessEnum.BLOCK"
Enum: "ALLOW" "BLOCK"
description
string
macAddresses
required
Array of strings [ 1 .. 128 ] items
name
required
string [ 2 .. 32 ] characters

Responses

Request samples

Content type
application/json
{
  • "access": "ALLOW",
  • "description": "string",
  • "macAddresses": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

L3ACL Policy

Manage layer-3 ACL policy profiles.

Delete Layer-3 ACL Profiles

Delete layer-3 ACL profiles.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Layer-3 ACL Profiles

Get layer-3 ACL profile collection.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Layer-3 ACL

Add layer-3 ACL by profile.

Request Body schema: application/json
defaultAccess
string
Default: "AccessEnum.ALLOW"
Enum: "ALLOW" "BLOCK"
description
string
Array of objects (L3Rule) [ 1 .. 128 ] items
name
required
string [ 2 .. 32 ] characters

Responses

Request samples

Content type
application/json
{
  • "defaultAccess": "ALLOW",
  • "description": "string",
  • "l3Rules": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Query Layer-3 ACL

Query layer-3 ACL profile.

Request Body schema: application/json
fields
Array of strings
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "page": 1,
  • "pageSize": 25,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "fields": [
    ],
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Layer-3 ACL

Delete layer-3 ACL by profile id.

path Parameters
l3AclPolicyId
required
string

L3Acl Policy ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Layer-3 ACL

Get layer-3 ACL by profile id.

path Parameters
l3AclPolicyId
required
string

L3Acl Policy ID

Responses

Response samples

Content type
application/json
{
  • "defaultAccess": "ALLOW",
  • "description": "string",
  • "id": "string",
  • "l3Rules": [
    ],
  • "name": "string"
}

Update Layer-3 ACL

Update layer-3 ACL by profile id.

path Parameters
l3AclPolicyId
required
string

L3Acl Policy ID

Request Body schema: application/json
defaultAccess
string
Default: "AccessEnum.ALLOW"
Enum: "ALLOW" "BLOCK"
description
string
Array of objects (L3Rule) [ 1 .. 128 ] items
name
required
string [ 2 .. 32 ] characters

Responses

Request samples

Content type
application/json
{
  • "defaultAccess": "ALLOW",
  • "description": "string",
  • "l3Rules": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Client Isolation Allowlist

Manage client isolation allowlists.

Client isolation features, when enabled, prevent clients residing on a common VLAN from exchanging packets with each other. Client isolation is enforced by APs working at layer 2 (bridging). If client isolation is needed between VLANs/IP subnets, routers must also be configured to prevent packet exchange at layer 3. A client isolation allowlist provides the capability for administrators to configure exceptions to this isolation behavior. For example, an administrator may want to allow clients on a public network to access a printer in a common area of their venue. If so, the MAC and IP addresses of the printer (or any excepted device) can be configured on the client isolation allowlist.

Client isolation can be used in conjunction with walled gardens for public networks. Walled gardens provide limited access to services prior to client authentication whereas client isolation allowlists provide connectivity options post authentication.

Client isolation does not work when clients are assigned static IP addresses. For this reason, Ruckus recommends using DHCP lease reservations in lieu of static IP addresses when using this feature. Administrators may also want to consider use of the force DHCP option, available during wireless network configuration.

Complications to client isolation can arise when the VLAN's default gateway employs VRRP or HSRP for high availability or when Bonjour gateway is configured on the same WLAN as the allowlist. If either of these situations applies in your network, please contact Ruckus customer support for assistance.

Delete Isolation Allowlists

Delete client isolation allowlists.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Client Isolation Allowlists

Get the client isolation allowlists.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Client Isolation Allowlist

Create a new client isolation allowlist.

Request Body schema: application/json
required
Array of objects (ClientIsolationAllowlistEntry) [ 1 .. 64 ] items
description
string [ 0 .. 64 ] characters
name
required
string [ 2 .. 32 ] characters
venueId
string

Required before new UI.

Responses

Request samples

Content type
application/json
{
  • "allowlist": [
    ],
  • "description": "string",
  • "name": "string",
  • "venueId": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Delete Client Isolation Allowlist

Delete this client isolation allowlist.

path Parameters
clientIsolationAllowlistId
required
string

Client Isolation Allowlist ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Client Isolation Allowlist

Get the details for this client isolation allowlist.

path Parameters
clientIsolationAllowlistId
required
string

Client Isolation Allowlist ID

Responses

Response samples

Content type
application/json
{
  • "allowlist": [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "tenantId": "string",
  • "venueId": "string"
}

Update Client Isolation Allowlist

Update this client isolation allowlist.

path Parameters
clientIsolationAllowlistId
required
string

Client Isolation Allowlist ID

Request Body schema: application/json
required
Array of objects (ClientIsolationAllowlistEntry) [ 1 .. 64 ] items
description
string [ 0 .. 64 ] characters
name
required
string [ 2 .. 32 ] characters
venueId
string

Required before new UI.

Responses

Request samples

Content type
application/json
{
  • "allowlist": [
    ],
  • "description": "string",
  • "name": "string",
  • "venueId": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Device-Policy

Manage device policies.

Delete Device-Policies

Delete a list of device-policies.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get All Device Policies

Get the device-policy collection.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Device-Policy

Create a new device-policy.

Request Body schema: application/json
defaultAccess
string
Default: "AccessEnum.ALLOW"
Enum: "ALLOW" "BLOCK"
description
string [ 2 .. 180 ] characters
name
required
string [ 2 .. 32 ] characters
Array of objects (DevicePolicyRule) [ 1 .. 32 ] items

Responses

Request samples

Content type
application/json
{
  • "defaultAccess": "ALLOW",
  • "description": "string",
  • "name": "string",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Device-Policies

Get the device-policy list.

Request Body schema: application/json
fields
Array of strings
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "page": 1,
  • "pageSize": 25,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "fields": [
    ],
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Device-Policy

Delete a device-policy.

path Parameters
devicePolicyId
required
string

Device-policy ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Device-Policy

Get the device-policy details.

path Parameters
devicePolicyId
required
string

Device-policy ID

Responses

Response samples

Content type
application/json
{
  • "defaultAccess": "ALLOW",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "rules": [
    ],
  • "tenantId": "string"
}

Update Device-Policy

Update a device-policy.

path Parameters
devicePolicyId
required
string

Device-policy ID

Request Body schema: application/json
defaultAccess
string
Default: "AccessEnum.ALLOW"
Enum: "ALLOW" "BLOCK"
description
string [ 2 .. 180 ] characters
name
required
string [ 2 .. 32 ] characters
Array of objects (DevicePolicyRule) [ 1 .. 32 ] items

Responses

Request samples

Content type
application/json
{
  • "defaultAccess": "ALLOW",
  • "description": "string",
  • "name": "string",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Syslog Server Profile

Manage Syslog server profiles.

Delete Syslog Server Profiles

Delete a list of syslog server profiles.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Syslog Server Profiles

Get the syslog server profiles.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Syslog Server Profile

Create a new syslog server profile.

Request Body schema: application/json
facility
string
Default: "FacilityEnum.KEEP_ORIGINAL"
Enum: "KEEP_ORIGINAL" "LOCAL0" "LOCAL1" "LOCAL2" "LOCAL3" "LOCAL4" "LOCAL5" "LOCAL6" "LOCAL7"
flowLevel
string
Default: "FlowLevelEnum.CLIENT_FLOW"
Enum: "GENERAL_LOGS" "CLIENT_FLOW" "ALL"
name
required
string [ 2 .. 32 ] characters ^[!-~]([ -~])*[!-~]$
required
object (SyslogServer)

Syslog server

priority
string
Default: "PriorityEnum.INFO"
Enum: "EMERGENCY" "ALERT" "CRITICAL" "ERROR" "WARNING" "NOTICE" "INFO" "ALL"
object (SyslogServer)

Syslog server

Array of objects (IdAndName)

Responses

Request samples

Content type
application/json
{
  • "facility": "KEEP_ORIGINAL",
  • "flowLevel": "GENERAL_LOGS",
  • "name": "string",
  • "primary": {
    },
  • "priority": "EMERGENCY",
  • "secondary": {
    },
  • "venues": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Delete Syslog Server Profile

Delete a syslog server profile.

path Parameters
syslogServerProfileId
required
string

Syslog Server Profile ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Syslog Server Profile

Get the syslog server profile details.

path Parameters
syslogServerProfileId
required
string

Syslog Server Profile ID

Responses

Response samples

Content type
application/json
{
  • "facility": "KEEP_ORIGINAL",
  • "flowLevel": "GENERAL_LOGS",
  • "id": "string",
  • "name": "string",
  • "primary": {
    },
  • "priority": "EMERGENCY",
  • "secondary": {
    },
  • "venues": [
    ]
}

Update Syslog Server Profile

Update a syslog server profile.

path Parameters
syslogServerProfileId
required
string

Syslog Server Profile ID

Request Body schema: application/json
facility
string
Default: "FacilityEnum.KEEP_ORIGINAL"
Enum: "KEEP_ORIGINAL" "LOCAL0" "LOCAL1" "LOCAL2" "LOCAL3" "LOCAL4" "LOCAL5" "LOCAL6" "LOCAL7"
flowLevel
string
Default: "FlowLevelEnum.CLIENT_FLOW"
Enum: "GENERAL_LOGS" "CLIENT_FLOW" "ALL"
name
required
string [ 2 .. 32 ] characters ^[!-~]([ -~])*[!-~]$
required
object (SyslogServer)

Syslog server

priority
string
Default: "PriorityEnum.INFO"
Enum: "EMERGENCY" "ALERT" "CRITICAL" "ERROR" "WARNING" "NOTICE" "INFO" "ALL"
object (SyslogServer)

Syslog server

Array of objects (IdAndName)

Responses

Request samples

Content type
application/json
{
  • "facility": "KEEP_ORIGINAL",
  • "flowLevel": "GENERAL_LOGS",
  • "name": "string",
  • "primary": {
    },
  • "priority": "EMERGENCY",
  • "secondary": {
    },
  • "venues": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Access Control Profile

Manage access control profiles.

Delete Multiple Access Control Profiles

Delete multiple access control profiles by profile identities.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get All Access Control Profiles

Get all access control profiles.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Access Control Profile

Add an access control profile.

Request Body schema: application/json
object (IdAndEnabled)

Profile ID and enabled

description
string [ 0 .. 64 ] characters
object (IdAndEnabled)

Profile ID and enabled

object (IdAndEnabled)

Profile ID and enabled

object (IdAndEnabled)

Profile ID and enabled

name
required
string [ 2 .. 32 ] characters
object (RateLimiting)

Client traffic rate limiting

Responses

Request samples

Content type
application/json
{
  • "applicationPolicy": {
    },
  • "description": "string",
  • "devicePolicy": {
    },
  • "l2AclPolicy": {
    },
  • "l3AclPolicy": {
    },
  • "name": "string",
  • "rateLimiting": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Query Access Control Profiles

Get access control profiles by query.

Request Body schema: application/json
fields
Array of strings
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "page": 1,
  • "pageSize": 25,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "fields": [
    ],
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Access Control Profile

Delete the specified access control profile.

path Parameters
accessControlProfileId
required
string

Access control profile identity

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Access Control Profile

Get an access control profile by profile identity.

path Parameters
accessControlProfileId
required
string

Access control profile identity

Responses

Response samples

Content type
application/json
{
  • "applicationPolicy": {
    },
  • "description": "string",
  • "devicePolicy": {
    },
  • "id": "string",
  • "l2AclPolicy": {
    },
  • "l3AclPolicy": {
    },
  • "name": "string",
  • "rateLimiting": {
    }
}

Update Access Control Profile

Update the specified access control profile.

path Parameters
accessControlProfileId
required
string

Access control profile identity

Request Body schema: application/json
object (IdAndEnabled)

Profile ID and enabled

description
string [ 0 .. 64 ] characters
object (IdAndEnabled)

Profile ID and enabled

object (IdAndEnabled)

Profile ID and enabled

object (IdAndEnabled)

Profile ID and enabled

name
required
string [ 2 .. 32 ] characters
object (RateLimiting)

Client traffic rate limiting

Responses

Request samples

Content type
application/json
{
  • "applicationPolicy": {
    },
  • "description": "string",
  • "devicePolicy": {
    },
  • "l2AclPolicy": {
    },
  • "l3AclPolicy": {
    },
  • "name": "string",
  • "rateLimiting": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

VLAN Pool

Manage VLAN pool profiles.

Query VLAN Pools

Use this API command to delete a VLAN pool list.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get VLAN Pools

Use this API command to get the VLAN pool list.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add VLAN Pool

Use this API command to create a new VLAN pool.

Request Body schema: application/json
description
string [ 0 .. 64 ] characters
name
required
string [ 1 .. 32 ] characters
vlanMembers
required
Array of strings [ 0 .. 16 ] items

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "vlanMembers": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Query VLAN Pool

Use this API command to get the VLAN pool list by query.

Request Body schema: application/json
fields
Array of strings
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "page": 1,
  • "pageSize": 25,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "fields": [
    ],
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete VLAN Pool

Use this API command to delete a VLAN pool.

path Parameters
vlanPoolId
required
string

VLAN Pool ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get VLAN Pool

Use this API command to get the VLAN pool details.

path Parameters
vlanPoolId
required
string

VLAN Pool ID

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "tenantId": "string",
  • "vlanMembers": [
    ]
}

Partial Update VLAN Pool

Use this API command to partial update a VLAN pool.

path Parameters
vlanPoolId
required
string

VLAN Pool ID

Request Body schema: application/json
description
string [ 0 .. 64 ] characters
name
string [ 1 .. 32 ] characters
vlanMembers
Array of strings [ 0 .. 16 ] items

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "vlanMembers": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Update VLAN Pool

Use this API command to update a VLAN pool.

path Parameters
vlanPoolId
required
string

VLAN Pool ID

Request Body schema: application/json
description
string [ 0 .. 64 ] characters
name
required
string [ 1 .. 32 ] characters
vlanMembers
required
Array of strings [ 0 .. 16 ] items

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "vlanMembers": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Application Policy

Manage application policy profiles.

Delete Application Policies

Use this API command to delete an application policy list.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Application Policies

Use this API command to get the application policy list.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Application Policy

Use this API command to create a new application policy.

Request Body schema: application/json
description
string [ 0 .. 64 ] characters
name
required
string [ 2 .. 32 ] characters
Array of objects (ApplicationPolicyRule) [ 1 .. 128 ] items

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Query Application Policy

Use this API command to get the application policy list by query.

Request Body schema: application/json
fields
Array of strings
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "page": 1,
  • "pageSize": 25,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "fields": [
    ],
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Application Policy

Use this API command to delete application policy.

path Parameters
applicationPolicyId
required
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Application Policy

Use this API command to get the application policy details.

path Parameters
applicationPolicyId
required
string

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "rules": [
    ],
  • "tenantId": "string"
}

Update Application Policy

Use this API command to update application policy.

path Parameters
applicationPolicyId
required
string
Request Body schema: application/json
description
string [ 0 .. 64 ] characters
name
required
string [ 2 .. 32 ] characters
Array of objects (ApplicationPolicyRule) [ 1 .. 128 ] items

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

AP

Manage APs including pinging, trace-routing, resetting, rebooting, floor-plan positioning, Bonjour gateway and LAN-Ports settings.

Get APs by AP-Group

Get the APs in the AP-group.

path Parameters
apGroupId
required
string

AP-group ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete APs

Delete a list of APs.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get APs

Get the AP list.

query Parameters
operational
boolean
Default: false

Include operational data in response

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add APs

Add a list of new APs.

Request Body schema:
Array
apGroupId
string
description
string [ 0 .. 180 ] characters
object (DeviceGps)

Ap or Venue latitude and longitude

model
string [ 0 .. 64 ] characters
Default: "null"
name
required
string(?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$
object (ApPosition)

AP position object

serialNumber
required
string^[1-9][0-9]{11}$
tags
Array of strings [ 0 .. 24 ] items
venueId
required
string

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Delete AP

Delete an AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get AP

Get the AP operational and configuration data.

path Parameters
serialNumber
required
string

The serial number of the AP.

query Parameters
operational
boolean
Default: false

Include operational data in response

Responses

Response samples

Content type
application/json
{
  • "apGroupId": "string",
  • "bonjourGateway": {
    },
  • "clientCount": 0,
  • "description": "string",
  • "deviceGps": {
    },
  • "externalIp": "null",
  • "firmware": "null",
  • "indoorModel": false,
  • "ip": "null",
  • "lanPorts": {
    },
  • "lastContacted": "null",
  • "lastUpdated": "null",
  • "mac": "null",
  • "meshRole": "null",
  • "model": "null",
  • "name": "string",
  • "poePortStatus": "null",
  • "position": {
    },
  • "radio": {
    },
  • "serialNumber": "string",
  • "softDeleted": false,
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "state": "InSetupPhase",
  • "subState": "NeverContactedCloud",
  • "tags": [
    ],
  • "uptime_seconds": 0,
  • "venueId": "string"
}

Trigger AP Action

Trigger AP action.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
action
required
string
Enum: "ping" "traceRoute" "reboot" "factoryReset" "blinkLed"
targetHost
string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9...

Responses

Request samples

Content type
application/json
{
  • "action": "ping",
  • "targetHost": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Update AP

Update an AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
apGroupId
string
description
string [ 0 .. 180 ] characters
object (DeviceGps)

Ap or Venue latitude and longitude

model
string [ 0 .. 64 ] characters
Default: "null"
name
required
string(?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$
object (ApPosition)

AP position object

serialNumber
required
string^[1-9][0-9]{11}$
tags
Array of strings [ 0 .. 24 ] items
venueId
required
string

Responses

Request samples

Content type
application/json
{
  • "apGroupId": "string",
  • "description": "string",
  • "deviceGps": {
    },
  • "model": "null",
  • "name": "string",
  • "position": {
    },
  • "serialNumber": "string",
  • "tags": [
    ],
  • "venueId": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get AP Capabilities

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "apModels": [
    ]
}

Get AP Default Regulatory-Channels

Get AP default regulatory channels.

path Parameters
serialNumber
required
string

AP serialNumber

Responses

Response samples

Content type
application/json
{
  • "2.4GChannels": {
    },
  • "5GChannels": {
    },
  • "5GLowerChannels": {
    },
  • "5GUpperChannels": {
    },
  • "6GChannels": {
    }
}

Get DHCP Lease Times

Get DHCP lease time collections.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get DHCP Pool Usages

Get DHCP pool usage.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Reset AP Directed Multicast Settings

Reset AP directed multicast to default settings.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get AP Directed Multicast Settings

Get directed multicast settings for this AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "networkEnabled": false,
  • "useVenueSettings": true,
  • "wiredEnabled": false,
  • "wirelessEnabled": false
}

Update AP Directed Multicast Settings

Update directed multicast settings of this AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
networkEnabled
boolean
Default: false
useVenueSettings
boolean
Default: true
wiredEnabled
boolean
Default: false
wirelessEnabled
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "networkEnabled": false,
  • "useVenueSettings": true,
  • "wiredEnabled": false,
  • "wirelessEnabled": false
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Update AP Position

Update an AP floor-plan position.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
floorplanId
string
xPercent
number <float> [ 0 .. 100 ]
Default: 0
yPercent
number <float> [ 0 .. 100 ]
Default: 0

Responses

Request samples

Content type
application/json
{
  • "floorplanId": "string",
  • "xPercent": 0,
  • "yPercent": 0
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Reset AP LAN-Ports

Reset the LAN-ports of an AP to the default values.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get AP LAN-Ports

Get AP LAN-ports details.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "lanPorts": [
    ],
  • "poeOut": false,
  • "useVenueSettings": false
}

Update AP LAN-Ports

Update LAN-ports of an AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
Array of objects (ApLanPort)
poeOut
boolean
Default: false
useVenueSettings
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "lanPorts": [
    ],
  • "poeOut": false,
  • "useVenueSettings": false
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Download AP Log

Download the AP log file.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "fileURL": "string"
}

Reset AP MDNS Proxy Settings

Reset the AP MDNS proxy settings.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get AP MDNS Proxy Settings

Get the AP MDNS proxy settings.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ]
}

Update AP MDNS Proxy Settings

Update the AP MDNS proxy settings.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
required
Array of objects (BonjourGatewayRule) [ 1 .. 2147483647 ] items

Responses

Request samples

Content type
application/json
{
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Stop Packet Capture

Stop packet capture.

path Parameters
serialNumber
required
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Packet Capture State

Get packet capture state.

path Parameters
serialNumber
required
string

Responses

Response samples

Content type
application/json
{
  • "fileUrl": "string",
  • "state": "Capturing"
}

Start Packet Capture

Start packet capture.

path Parameters
serialNumber
required
string
Request Body schema: application/json
captureInterface
required
string
Enum: "RADIO24" "RADIO50" "RADIO50UPPER" "RADIO50LOWER" "RADIO60" "ETH0" "ETH1" "ETH2" "ETH3" "ETH4" "ETH5" "ETH6" "ETH7"
frameTypeFilter
Array of strings
Items Enum: "MANAGEMENT" "CONTROL" "DATA"
macAddressFilter
string^$|^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$|...

Responses

Request samples

Content type
application/json
{
  • "captureInterface": "RADIO24",
  • "frameTypeFilter": [
    ],
  • "macAddressFilter": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Delete AP Picture

Delete AP picture.

path Parameters
serialNumber
required
string
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get AP Picture

Get AP picture.

path Parameters
serialNumber
required
string
tenantId
required
string

Tenant ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "imageId": "null",
  • "imageName": "null",
  • "imageUrl": "string"
}

Upload AP Picture

Upload AP picture.

path Parameters
serialNumber
required
string
tenantId
required
string

Tenant ID

Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Reset AP Radio Customization

Reset AP radio to default settings.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get AP Radio

Get AP radio details.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "apRadioParams24G": {
    },
  • "apRadioParams50G": {
    },
  • "apRadioParams6G": {
    },
  • "apRadioParamsDual5G": {
    },
  • "enable24G": false,
  • "enable50G": false,
  • "enable6G": false,
  • "useVenueSettings": true
}

Update AP Radio

Update an AP radio settings.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
object (ApRadioParams24G)

AP radio customization for 2.4GHz.

object (ApRadioParams50G)

AP radio customization for 5GHz.

object (ApRadioParams6G)

AP radio customization for 6GHz.

object (ApRadioParamsDual5G)

AP radio customization for dual 5GHz radios.

enable24G
boolean
Default: false
enable50G
boolean
Default: false
enable6G
boolean
Default: false
useVenueSettings
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "apRadioParams24G": {
    },
  • "apRadioParams50G": {
    },
  • "apRadioParams6G": {
    },
  • "apRadioParamsDual5G": {
    },
  • "enable24G": false,
  • "enable50G": false,
  • "enable6G": false,
  • "useVenueSettings": true
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Reset AP Customization

Reset the customization of an AP to the default values.

path Parameters
serialNumber
required
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get AP Customization

GET AP customization details.

path Parameters
serialNumber
required
string

Responses

Response samples

Content type
application/json
{
  • "externalAntenna": {
    },
  • "id": "string",
  • "lanPorts": [
    ],
  • "poeOut": false,
  • "useVenueSettings": false
}

Update AP Customization

Update the customization of an AP.

path Parameters
serialNumber
required
string
Request Body schema: application/json
object (ExternalAntenna)

External antenna settings

Array of objects (ApLanPort)
poeOut
boolean
Default: false
useVenueSettings
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "externalAntenna": {
    },
  • "lanPorts": [
    ],
  • "poeOut": false,
  • "useVenueSettings": false
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

AP-Venue

Manage Wi-Fi venue configuration, including radio settings, mesh, LEDs, LAN-ports, and syslog.

Get Available LTE Bands

Get available LTE bands for each region.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Venues

Get the venue list of Wi-Fi details.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Venue Capabilities

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "apModels": [
    ]
}

Get Venue AP-Model Cellular

Get AP model cellular settings and LTE band lock channels of the venue.

path Parameters
venueId
required
string

Responses

Response samples

Content type
application/json
{
  • "model": "string",
  • "primarySim": {
    },
  • "primaryWanRecoveryTimer": 10,
  • "secondarySim": {
    },
  • "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}

Update Venue AP-Model Cellular

Update AP model cellular settings and LTE band lock channels of the venue.

path Parameters
venueId
required
string
Request Body schema: application/json
model
string [ 0 .. 64 ] characters
object (SimSettings)

SIM setting object.

primaryWanRecoveryTimer
required
integer <int32> [ 10 .. 300 ]
object (SimSettings)

SIM setting object.

wanConnection
required
string
Enum: "ETH_WITH_CELLULAR_FAILOVER" "CELLULAR_WITH_ETH_FAILOVER" "ETH" "CELLULAR"

Responses

Request samples

Content type
application/json
{
  • "model": "string",
  • "primarySim": {
    },
  • "primaryWanRecoveryTimer": 10,
  • "secondarySim": {
    },
  • "wanConnection": "ETH_WITH_CELLULAR_FAILOVER"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Venue Default Regulatory-Channels

Get venue default regulatory channels.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "2.4GChannels": {
    },
  • "5GChannels": {
    },
  • "5GLowerChannels": {
    },
  • "5GUpperChannels": {
    },
  • "6GChannels": {
    }
}

Get Venue DHCP Service

Get a list of this DHCP service settings of this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "dhcpServiceAps": [
    ],
  • "dhcpServiceProfileIds": [
    ],
  • "enableClientIsolationAllowlist": false,
  • "enabled": false,
  • "mode": "EnableOnEachAPs",
  • "wanPortSelectionMode": "Dynamic"
}

Update Venue DHCP Service

Update DHCP service settings of this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
Array of objects (DhcpServiceAp)
dhcpServiceProfileIds
Array of strings
enableClientIsolationAllowlist
boolean
Default: false
enabled
boolean
Default: false
mode
string
Default: "DhcpModeEnum.EnableOnEachAPs"
Enum: "EnableOnEachAPs" "EnableOnMultipleAPs" "EnableOnHierarchicalAPs"
wanPortSelectionMode
string
Default: "DhcpWanPortSelectionModeEnum.Dynamic"
Enum: "Dynamic" "Manual"

Responses

Request samples

Content type
application/json
{
  • "dhcpServiceAps": [
    ],
  • "dhcpServiceProfileIds": [
    ],
  • "enableClientIsolationAllowlist": false,
  • "enabled": false,
  • "mode": "EnableOnEachAPs",
  • "wanPortSelectionMode": "Dynamic"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Venue DHCP Leases

Get a list of DHCP leases of the venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Venue DHCP Pools

Get a list of DHCP pool usage of the venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Venue Directed Multicast Settings

Get directed multicast settings for this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "networkEnabled": true,
  • "wiredEnabled": true,
  • "wirelessEnabled": true
}

Update Venue Directed Multicast Settings

Update venue directed multicast settings of this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
networkEnabled
boolean
Default: true
wiredEnabled
boolean
Default: true
wirelessEnabled
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "networkEnabled": true,
  • "wiredEnabled": true,
  • "wirelessEnabled": true
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Venue DoS Protection

Get DoS protection of this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "blockingPeriod": 60,
  • "checkPeriod": 30,
  • "enabled": false,
  • "failThreshold": 5
}

Update Venue DoS Protection

Update DoS protection of this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
blockingPeriod
integer <int32> [ 30 .. 600 ]
Default: 60
checkPeriod
integer <int32> [ 30 .. 600 ]
Default: 30
enabled
boolean
Default: false
failThreshold
integer <int32> [ 2 .. 25 ]
Default: 5

Responses

Request samples

Content type
application/json
{
  • "blockingPeriod": 60,
  • "checkPeriod": 30,
  • "enabled": false,
  • "failThreshold": 5
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Venue External Antenna

List venue external antenna settings. The settings are defined per AP model.

path Parameters
venueId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Venue External Antenna

Update a venue external antenna settings. The settings are defined per AP model.

path Parameters
venueId
required
string
Request Body schema: application/json
Array
enable24G
boolean
Default: false
enable50G
boolean
Default: false
gain24G
integer <int32> [ 0 .. 60 ]
gain50G
integer <int32> [ 0 .. 60 ]
model
string [ 0 .. 64 ] characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Venue LAN-Ports

List venue LAN-port settings. The settings are defined per AP model.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Venue LAN-Ports

Update a venue LAN-port settings. The settings are defined per AP model.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
Array
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: false

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Venue LED

Get venue LED settings. The settings are defined per AP model.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Venue LED

Update venue LED settings. The settings are defined per AP model.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
Array
ledEnabled
boolean
Default: false
model
string [ 0 .. 64 ] characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Update Mesh

Enable/disable the venue mesh.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
enabled
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Reset Venue Radio

Reset venue radio to default values.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Venue Radio

Get the venue radio.

path Parameters
venueId
required
string

Venue ID

query Parameters
defaultOnly
boolean
Default: false

Only get the details of default radio settings in this venue.

Responses

Response samples

Content type
application/json
{
  • "radioParams24G": {
    },
  • "radioParams50G": {
    },
  • "radioParams6G": {
    },
  • "radioParamsDual5G": {
    }
}

Update Venue Radio

Update the venue radio.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
object (RadioParams24G)

Radio customization for 2.4GHz.

object (RadioParams50G)

Radio customization for 5GHz.

object (RadioParams6G)

Radio customization for 6GHz.

object (RadioParamsDual5G)

Radio customization for dual 5GHz radios.

Responses

Request samples

Content type
application/json
{
  • "radioParams24G": {
    },
  • "radioParams50G": {
    },
  • "radioParams6G": {
    },
  • "radioParamsDual5G": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Venue Rogue AP

Get the venue rogue AP settings.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "enabled": false,
  • "reportThreshold": 0,
  • "roguePolicyId": "string"
}

Update Venue Rogue AP

Update the venue rogue AP settings.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
enabled
boolean
Default: false
reportThreshold
integer <int32> [ 0 .. 100 ]
Default: 0
roguePolicyId
string

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "reportThreshold": 0,
  • "roguePolicyId": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Venue Syslog Server Profile Settings

Get venue syslog server profile settings.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "enabled": false,
  • "serviceProfileId": "string"
}

Update Venue Syslog Server Profile Settings

Update a venue syslog server profile settings.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
enabled
boolean
Default: false
serviceProfileId
string

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "serviceProfileId": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Reset Venue Syslog

Reset venue syslog settings to default values.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Venue Syslog

Get the venue syslog settings.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "enabled": false,
  • "facility": "KEEP_ORIGINAL",
  • "flowLevel": "GENERAL_LOGS",
  • "port": 514,
  • "priority": "EMERGENCY",
  • "protocol": "TCP",
  • "secondaryPort": 514,
  • "secondaryProtocol": "TCP",
  • "secondaryServer": "string",
  • "server": "string"
}

Update Venue Syslog

Update the venue syslog settings.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
enabled
boolean
Default: false
facility
string
Default: "FacilityEnum.KEEP_ORIGINAL"
Enum: "KEEP_ORIGINAL" "LOCAL0" "LOCAL1" "LOCAL2" "LOCAL3" "LOCAL4" "LOCAL5" "LOCAL6" "LOCAL7"
flowLevel
string
Default: "FlowLevelEnum.CLIENT_FLOW"
Enum: "GENERAL_LOGS" "CLIENT_FLOW" "ALL"
port
integer <int32> [ 1 .. 65535 ]
Default: 514
priority
string
Default: "PriorityEnum.INFO"
Enum: "EMERGENCY" "ALERT" "CRITICAL" "ERROR" "WARNING" "NOTICE" "INFO" "ALL"
protocol
string
Default: "ProtocolEnum.UDP"
Enum: "TCP" "UDP"
secondaryPort
integer <int32> [ 1 .. 65535 ]
Default: 514
secondaryProtocol
string
Default: "ProtocolEnum.TCP"
Enum: "TCP" "UDP"
secondaryServer
string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9...
server
string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9...

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "facility": "KEEP_ORIGINAL",
  • "flowLevel": "GENERAL_LOGS",
  • "port": 514,
  • "priority": "EMERGENCY",
  • "protocol": "TCP",
  • "secondaryPort": 514,
  • "secondaryProtocol": "TCP",
  • "secondaryServer": "string",
  • "server": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Venue

Get the venue Wi-Fi details.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "apPassword": "string",
  • "bandBalancing": {
    },
  • "countryCode": "string",
  • "denialOfServiceProtection": {
    },
  • "dhcpServiceSetting": {
    },
  • "enableClientIsolationAllowlist": false,
  • "id": "string",
  • "lteBandLockChannels": [
    ],
  • "mesh": {
    },
  • "radioCustomization": {
    },
  • "rogueAp": {
    },
  • "syslog": {
    },
  • "tenantId": "string",
  • "wifiFirmwareVersion": "string"
}

Recovery

Retrieve and set the recovery PSK.

Get Application Policies Applications

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Application Policies Categories

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Recovery PSK

Get the PSK for the recovery network.

Responses

Response samples

Content type
application/json
{
  • "obsolete": false,
  • "psk": "string",
  • "tenantId": "string"
}

Update Recovery PSK

Update the PSK for the recovery network.

Request Body schema: application/json
obsolete
boolean
Default: false
psk
string^([0-9]{4}){4}$

Responses

Request samples

Content type
application/json
{
  • "obsolete": false,
  • "psk": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Capabilities

Responses

Response samples

Content type
application/json
{
  • "apModels": [
    ]
}

Client

Manage client connections.

Clients Control

Control a list of clients.

Request Body schema: application/json
action
required
string
Value: "disconnect"
Array of objects (DisconnectClientBySerialNumber)

Responses

Request samples

Content type
application/json
{
  • "action": "disconnect",
  • "clients": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Network-Venue

Manage network-venue profiles.

Delete Network-Venues

Delete a list of network-venue activation.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Create Network-Venue

Create a new network-venue activation.

Request Body schema: application/json
allApGroupsRadio
string
Deprecated
Default: "RadioEnum.Both"
Enum: "Both" "2.4-GHz" "5-GHz"
allApGroupsRadioTypes
Array of strings
Items Enum: "2.4-GHz" "5-GHz" "6-GHz"
allApGroupsVlanId
integer <int32> [ 1 .. 4094 ]
Array of objects (NetworkApGroup)
clientIsolationAllowlistId
string
isAllApGroups
boolean
Default: true
networkId
string
object (NetworkVenueScheduler)

Network-Venue scheduler

venueId
string
vlanPoolId
string

Responses

Request samples

Content type
application/json
{
  • "allApGroupsRadio": "Both",
  • "allApGroupsRadioTypes": [
    ],
  • "allApGroupsVlanId": 1,
  • "apGroups": [
    ],
  • "clientIsolationAllowlistId": "string",
  • "isAllApGroups": true,
  • "networkId": "string",
  • "scheduler": {
    },
  • "venueId": "string",
  • "vlanPoolId": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Network-Venues Activation

Get network-venue activation list.

Request Body schema: application/json
networkId
string
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
venueId
string

Responses

Request samples

Content type
application/json
{
  • "networkId": "string",
  • "page": 1,
  • "pageSize": 25,
  • "venueId": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "fields": [
    ],
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Network-Venue

Delete a network-venue activation.

path Parameters
networkVenueId
required
string

Network-Venue ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Network-Venue Activation

Get the network-venue activation details.

path Parameters
networkVenueId
required
string

Network-Venue ID

Responses

Response samples

Content type
application/json
{
  • "allApGroupsRadio": "Both",
  • "allApGroupsRadioTypes": [
    ],
  • "allApGroupsVlanId": 1,
  • "apGroups": [
    ],
  • "clientIsolationAllowlistId": "string",
  • "dual5gEnabled": false,
  • "id": "string",
  • "isAllApGroups": true,
  • "networkId": "string",
  • "scheduler": {
    },
  • "tripleBandEnabled": false,
  • "venueId": "string",
  • "vlanPoolId": "string"
}

Update Network-Venue

Update this network-venue activation.

path Parameters
networkVenueId
required
string

Network-Venue ID

Request Body schema: application/json
allApGroupsRadio
string
Deprecated
Default: "RadioEnum.Both"
Enum: "Both" "2.4-GHz" "5-GHz"
allApGroupsRadioTypes
Array of strings
Items Enum: "2.4-GHz" "5-GHz" "6-GHz"
allApGroupsVlanId
integer <int32> [ 1 .. 4094 ]
Array of objects (NetworkApGroup)
clientIsolationAllowlistId
string
isAllApGroups
boolean
Default: true
networkId
string
object (NetworkVenueScheduler)

Network-Venue scheduler

venueId
string
vlanPoolId
string

Responses

Request samples

Content type
application/json
{
  • "allApGroupsRadio": "Both",
  • "allApGroupsRadioTypes": [
    ],
  • "allApGroupsVlanId": 1,
  • "apGroups": [
    ],
  • "clientIsolationAllowlistId": "string",
  • "isAllApGroups": true,
  • "networkId": "string",
  • "scheduler": {
    },
  • "venueId": "string",
  • "vlanPoolId": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

DHCP Service

Manage DHCP service-profiles.

Delete DHCP Service-Profiles

Delete a list of DHCP service-profiles.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get DHCP Service-Profiles

Get list of DHCP service-profiles.

query Parameters
excludeDefault
boolean
Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create DHCP Service-Profile

Create a new DHCP service-profile.

Request Body schema: application/json
endIpAddress
required
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-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]|1[0-9][0-9]|[1-9][...
secondaryDnsIp
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
startIpAddress
required
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
subnetAddress
required
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
subnetMask
required
string^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128...
Array of objects (IdAndName)
vlanId
required
integer <int32> [ 1 .. 4094 ]

Responses

Request samples

Content type
application/json
{
  • "endIpAddress": "string",
  • "leaseTimeHours": 24,
  • "leaseTimeMinutes": 59,
  • "name": "string",
  • "primaryDnsIp": "string",
  • "secondaryDnsIp": "string",
  • "startIpAddress": "string",
  • "subnetAddress": "string",
  • "subnetMask": "string",
  • "venues": [
    ],
  • "vlanId": 1
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Delete DHCP Service-Profile

Delete a DHCP service-profile.

path Parameters
dhcpServiceProfileId
required
string

DHCP Service-Profile ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get DHCP Service-Profile

Get the DHCP service-profile details.

path Parameters
dhcpServiceProfileId
required
string

DHCP Service-Profile ID

Responses

Response samples

Content type
application/json
{
  • "endIpAddress": "string",
  • "id": "string",
  • "leaseTimeHours": 24,
  • "leaseTimeMinutes": 59,
  • "name": "string",
  • "primaryDnsIp": "string",
  • "secondaryDnsIp": "string",
  • "startIpAddress": "string",
  • "subnetAddress": "string",
  • "subnetMask": "string",
  • "venues": [
    ],
  • "vlanId": 1
}

Update DHCP Service Profile

Update a DHCP service-profile.

path Parameters
dhcpServiceProfileId
required
string

DHCP Service-Profile ID

Request Body schema: application/json
endIpAddress
required
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-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]|1[0-9][0-9]|[1-9][...
secondaryDnsIp
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
startIpAddress
required
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
subnetAddress
required
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
subnetMask
required
string^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128...
Array of objects (IdAndName)
vlanId
required
integer <int32> [ 1 .. 4094 ]

Responses

Request samples

Content type
application/json
{
  • "endIpAddress": "string",
  • "leaseTimeHours": 24,
  • "leaseTimeMinutes": 59,
  • "name": "string",
  • "primaryDnsIp": "string",
  • "secondaryDnsIp": "string",
  • "startIpAddress": "string",
  • "subnetAddress": "string",
  • "subnetMask": "string",
  • "venues": [
    ],
  • "vlanId": 1
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

AP-Group

Manage AP-Groups.

Delete AP-Groups

Delete a list of AP-groups.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get AP-Groups

Get the AP-group list.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete AP-Group

Delete an AP-group.

path Parameters
apGroupId
required
string

AP-group ID

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get AP-Group

Get the AP-group details.

path Parameters
apGroupId
required
string

AP-group ID

Responses

Response samples

Content type
application/json
{
  • "aps": [
    ],
  • "description": "string",
  • "id": "string",
  • "isDefault": false,
  • "name": "string",
  • "venueId": "string"
}

Update AP-Group

Update an AP-group.
Note: AP-Groups cannot be moved between venues, but a single AP can be moved between venues using the update AP endpoint.

path Parameters
apGroupId
required
string

AP-group ID

Request Body schema: application/json
Array of objects (ApSerialNumber)
description
string [ 2 .. 180 ] characters
name
required
string [ 2 .. 64 ] characters
venueId
string
Deprecated

Responses

Request samples

Content type
application/json
{
  • "apSerialNumbers": [
    ],
  • "description": "string",
  • "name": "string",
  • "venueId": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get AP-Groups by Venue

Get the AP-group list by venue.

path Parameters
venueId
required
string

Venue ID

query Parameters
defaultOnly
boolean
Default: false

Only get the details of default AP Group in this venue.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create AP-Group

Create a new AP-group.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
Array of objects (ApSerialNumber)
description
string [ 2 .. 180 ] characters
name
required
string [ 2 .. 64 ] characters
venueId
string
Deprecated

Responses

Request samples

Content type
application/json
{
  • "apSerialNumbers": [
    ],
  • "description": "string",
  • "name": "string",
  • "venueId": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Rogue Classification Policy

Manage rogue classification policies.

Rogue APs are Wi-Fi APs which are in radio range of your Wi-Fi network, but are unknown to the Ruckus cloud. For example, these may be APs in installed your venues without explicit authorization from your administrators, whether added by a well-meaning employee or by a malicious attacker; as such, they could be on the same LAN as your authorized APs. They could also be APs installed in nearby venues (for example, if your venue is part of a multi-tenant facility). Rogue classification polices help to automatically classify these unknown APs by setting up rules which trigger a rogue AP report when specific-rogue detection criteria are met.

Delete Classification Policies

Delete a list of rogue classification policies.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Rogue Classification Policies

Get a list of rogue classification policies.

query Parameters
excludeDefault
boolean
Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Rogue Classification Policy

Create a rogue classification policy.

Request Body schema: application/json
description
string [ 0 .. 255 ] characters
name
required
string [ 2 .. 32 ] characters
Array of objects (RogueClassificationPolicyRule)
Array of objects (IdAndName)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "rules": [
    ],
  • "venues": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Delete Rogue Classification Policy

Delete this rogue classification policy.

path Parameters
roguePolicyId
required
string

Rogue classification policy ID.

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Rogue Classification Policy

Get this rogue classification policy.

path Parameters
roguePolicyId
required
string

Rogue classification policy ID.

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "rules": [
    ],
  • "venues": [
    ]
}

Update Rogue Classification Policy

Update this rogue classification policy.

path Parameters
roguePolicyId
required
string

Rogue classification policy ID.

Request Body schema: application/json
description
string [ 0 .. 255 ] characters
name
required
string [ 2 .. 32 ] characters
Array of objects (RogueClassificationPolicyRule)
Array of objects (IdAndName)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "rules": [
    ],
  • "venues": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Unbind Rogue Classification Policy from Venues

Delete the binding between a rogue classification policy and its list of venues and apply the default classification policy to those venues instead. Note that unbinding a policy from a venue does not disable rogue AP detection in that venue.

path Parameters
roguePolicyId
required
string

Rogue classification policy ID.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Create Rogue Classification Venue Bindings

Bind a rogue classification policy to a list of venues.

path Parameters
roguePolicyId
required
string

Rogue classification policy ID.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "requestId": "string"
}

import-dpsk-passphrases-rest-ctrl

Import DPSK Passphrases from CSV File

Import DPSK passphrases from CSV file.

path Parameters
networkId
required
string
query Parameters
usernamePrefix
string [ 0 .. 190 ] characters
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

import-aps-rest-ctrl

Get Result for Import APs from CSV File

Get result for import APs from CSV file.

query Parameters
requestId
required
string

The request-id of import aps request for querying the result.

Responses

Response samples

Content type
application/json
{
  • "downloadUrl": "string",
  • "errors": [
    ],
  • "fileErrorsCount": 0,
  • "txId": "string"
}