API docs by Redocly

RUCKUS ONE Experimental APIs

License: RUCKUS Cloud Privacy Policy
https://support.ruckuswireless.com/ruckus-cloud-wifi-legal-terms-and-conditions

Overview

The following are a list of experimental and beta APIs that are available to the RUCKUS One Beta customers. RUCKUS
reserves the right to change these experimental APIs without notice to API client developers. The process for
authenticating is detailed in the Overview section of our APIs. For the APIs presented here,
the highest level version is the experimental API, and all lower versions are qualified. Please see the
versioning section of our API for more information. For Role Based Access functionality, only the latest
version of the APIs will support custom roles.

RUCKUS One API Hosts

Region Domain Name
Asia https://api.asia.ruckus.cloud
Europe https://api.eu.ruckus.cloud
North America https://api.ruckus.cloud

Portal Service Profile

Manage Portal Service Profile.

Delete Portal Service Profile Deprecated

Delete portal service profile by ids.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get Portal Service Profiles Deprecated

Get portal service profile for the list.

query Parameters
serviceName
string

Portal Service Profile Name

networkId
string

NetworkId

tags
string

Tags

page
integer <int32>
Default: 1

Indicates the page to return, will be 1 based, and default to page 1

pageSize
integer <int32>
Default: 256

Default is 256, indicates the page size to return

excludeContent
boolean
Default: false

Get the total count information from the query and NOT pull the data

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "paging": {
    }
}

Add Portal Service Profile

Provision one portal service profile as defined in the payload. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
required
object (Guest_Service_API_&_Model_Documentation_PortalServiceProfileContentDto)
id
string
serviceName
string
tags
string

Responses

Request samples

Content type
{
  • "content": {
    },
  • "id": "string",
  • "serviceName": "string",
  • "tags": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Network Filter of Portal Service Profiles Deprecated

Get network filter for portal service profile lists.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Tags Filter of Portal Service Profiles Deprecated

Get tags filter for portal service profile lists.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Portal Service Profile

Delete portal service profile by id.

path Parameters
portalServiceProfileId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Portal Service Profile

Get a portal service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
portalServiceProfileId
required
string

Responses

Response samples

Content type
{
  • "content": {
    },
  • "id": "string",
  • "networkIds": [
    ],
  • "serviceName": "string",
  • "tags": "string"
}

Update Portal Service Profile

Update portal service profile by id. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
portalServiceProfileId
required
string
Request Body schema:
required
object (Guest_Service_API_&_Model_Documentation_PortalServiceProfileContentDto)
id
string
serviceName
string
tags
string

Responses

Request samples

Content type
{
  • "content": {
    },
  • "id": "string",
  • "serviceName": "string",
  • "tags": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Update Portal Service Profile Background Image

Update portal service profile background image by id.

path Parameters
portalServiceProfileId
required
string
Request Body schema:
required
image
string

A base 64 encoded string. Note that all images are saved as PNG files

Responses

Request samples

Content type
{
  • "image": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAADCAIAAADUVFKvAAAAFklEQVR4AWP4TwABAAAAAcADfzEPFwAAAABJRU5ErkJggg=="
}

Response samples

Content type
{
  • "requestId": "string"
}

Update Portal Service Profile Photo

Update portal service profile photo by id.

path Parameters
portalServiceProfileId
required
string
Request Body schema:
required
image
string

A base 64 encoded string. Note that all images are saved as PNG files

Responses

Request samples

Content type
{
  • "image": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAADCAIAAADUVFKvAAAAFklEQVR4AWP4TwABAAAAAcADfzEPFwAAAABJRU5ErkJggg=="
}

Response samples

Content type
{
  • "requestId": "string"
}

Update Portal Service Profile Powered Image

Update portal service profile powered image by id.

path Parameters
portalServiceProfileId
required
string
Request Body schema:
required
image
string

A base 64 encoded string. Note that all images are saved as PNG files

Responses

Request samples

Content type
{
  • "image": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAADCAIAAADUVFKvAAAAFklEQVR4AWP4TwABAAAAAcADfzEPFwAAAABJRU5ErkJggg=="
}

Response samples

Content type
{
  • "requestId": "string"
}

Guest User

Manage guest users.

Delete Guest Users Deprecated

Delete one or more guest users per their IDs as defined in the payload.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get Guest Users Deprecated

Get user details for the list of provisioned guest users.

query Parameters
page
integer <int32>

Page index

size
integer <int32>

The size of the page to be returned

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "totalElements": 0
}

Add Guest Users Deprecated

Provision one or more guest users as defined in the payload.

Request Body schema: application/json
required
Array
deliveryMethods
required
Array of strings unique
Items Enum: "MAIL" "SMS" "STUB" "PRINT"

At least one delivery method.

disabled
boolean

If true, this guest user will not be permitted to join the guest network.

email
string
required
object (Guest_Service_API_&_Model_Documentation_GuestUserExpiration)
maxDevices
required
integer <int32>

Maximum number of devices the guest user can simultaneously connect to the guest network. If set to minus one, no limit is enforced.

mobilePhoneNumber
required
string

The mobile phone number associated to the guest user.

name
required
string

The name assigned to the guest user.

networkId
required
string

Network ID of the guest network.

notes
string [ 0 .. 180 ] characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Delete Guest User by ID Deprecated

Delete a guest user.

path Parameters
guestUserId
required
string

Responses

Response samples

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

Get Guest User by ID Deprecated

Get a guest user.

path Parameters
guestUserId
required
string

Responses

Response samples

Content type
application/json
{
  • "createdDate": 0,
  • "deliveryMethods": [
    ],
  • "disabled": false,
  • "email": "string",
  • "expiration": {
    },
  • "expirationDate": 0,
  • "guestUserType": "GuestPass",
  • "id": "string",
  • "lastModified": 0,
  • "macAddresses": [
    ],
  • "maxDevices": 3,
  • "mobilePhoneNumber": "string",
  • "name": "string",
  • "networkId": "string",
  • "notes": "string",
  • "password": "string",
  • "ssid": "string"
}

Update Guest User Deprecated

Update guest user enable/disable status or create new password for the guest user.

path Parameters
guestUserId
required
string
Request Body schema: application/json
required

Parameter combination option:

Option1: Enable or disable user by "action: enabled" or "action: disabled".

Option2: Regenerate guest user credential by "action: regenerate" + "deliveryMethods"

action
required
string

Action for updating guest user.

deliveryMethods
Array of strings unique
Items Enum: "MAIL" "SMS" "STUB" "PRINT"

At least one delivery method.

Responses

Request samples

Content type
application/json
{
  • "action": "enabled",
  • "deliveryMethods": "MAIL"
}

Response samples

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

Import Guest Users by Network ID Deprecated

Import one or more guest pass users from the payload's CSV file.

path Parameters
networkId
required
string

Network ID of the guest network to which the guest user will connect.

query Parameters
expiration.activationType
required
string
Enum: "Creation" "Login"

When activation type is set to creation, the guest pass is valid when it's created until the specified expiration duration, even if it's not being used; when set to login, the guest pass is valid starting from when the user first logs on until the specified expiration duration.

expiration.duration
required
integer <int32> [ 1 .. 8760 ]
expiration.unit
required
string
Enum: "Minute" "Hour" "Day" "Week" "Month" "Year" "Never"
maxDevices
required
integer <int32>
Default: 3

Maximum number of devices the guest user can simultaneously connect to the guest network. If set to -1, no limit is enforced.

deliveryMethods
Array of strings unique
Items Enum: "MAIL" "SMS" "STUB" "PRINT"

At least one delivery method.

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

Responses

Response samples

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

Add Guest User

Create a new guest user.

path Parameters
wifiNetworkId
required
string

Network ID of the guest network to which the guest user will connect.

query Parameters
expiration.activationType
required
string
Enum: "Creation" "Login"

When activation type is set to creation, the guest pass is valid when it's created until the specified expiration duration, even if it's not being used; when set to login, the guest pass is valid starting from when the user first logs on until the specified expiration duration.

expiration.duration
required
integer <int32> [ 1 .. 8760 ]
expiration.unit
required
string
Enum: "Minute" "Hour" "Day" "Week" "Month" "Year" "Never"
maxDevices
required
integer <int32>
Default: 3

Maximum number of devices the guest user can simultaneously connect to the guest network. If set to -1, no limit is enforced.

deliveryMethods
Array of strings unique
Items Enum: "MAIL" "SMS" "STUB" "PRINT"

At least one delivery method.

Request Body schema:
required
deliveryMethods
required
Array of strings unique
Items Enum: "MAIL" "SMS" "STUB" "PRINT"

At least one delivery method.

disabled
boolean

If true, this guest user will not be permitted to join the guest network.

email
string
required
object (Guest_Service_API_&_Model_Documentation_GuestUserExpiration)
maxDevices
required
integer <int32>

Maximum number of devices the guest user can simultaneously connect to the guest network. If set to minus one, no limit is enforced.

mobilePhoneNumber
required
string

The mobile phone number associated to the guest user.

name
required
string

The name assigned to the guest user.

notes
string [ 0 .. 180 ] characters

Responses

Request samples

Content type
{
  • "deliveryMethods": [
    ],
  • "disabled": false,
  • "email": "string",
  • "expiration": {
    },
  • "maxDevices": 3,
  • "mobilePhoneNumber": "string",
  • "name": "string",
  • "notes": "string"
}

Response samples

Content type
Example
{
  • "requestId": "string",
  • "response": [
    ]
}

Delete Guest User by ID

Delete a guest user.

path Parameters
wifiNetworkId
required
string
guestUserId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Guest User by ID

Get a guest user.

path Parameters
wifiNetworkId
required
string
guestUserId
required
string

Responses

Response samples

Content type
{
  • "createdDate": 0,
  • "deliveryMethods": [
    ],
  • "disabled": false,
  • "email": "string",
  • "expiration": {
    },
  • "expirationDate": 0,
  • "guestUserType": "GuestPass",
  • "id": "string",
  • "lastModified": 0,
  • "macAddresses": [
    ],
  • "maxDevices": 3,
  • "mobilePhoneNumber": "string",
  • "name": "string",
  • "notes": "string",
  • "password": "string",
  • "ssid": "string"
}

Update Guest User

Update guest user enable/disable status or create new password for the guest user.

path Parameters
wifiNetworkId
required
string
guestUserId
required
string
Request Body schema:
required

Parameter combination option:

Option1: Enable or disable user by "disabled: false" or "disabled: true".

Option2: Regenerate guest user credential by "action: regeneratePassword" + "deliveryMethods"

action
string
Enum: "regeneratePassword" "passwordValidation"

Action for updating guest user.

deliveryMethods
Array of strings unique
Items Enum: "MAIL" "SMS" "STUB" "PRINT"

At least one delivery method.

disabled
boolean

If true, this guest user will not be permitted to join the guest network.

password
string

Manual password. The password must contain at least 6 characters (up to 16). The following characters are permitted: a-z, A-Z, 0-9, and other special characters !@#$%^&*()[]{}-_+=~`|:;"'<>,./?.

Responses

Request samples

Content type
{
  • "action": "regeneratePassword",
  • "deliveryMethods": [
    ],
  • "disabled": false,
  • "password": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

AAA Setting

Manage AAA (authentication, authorization, and accounting) Settings.

Retrieve AAA Setting

Retrieve venue's authentication, authorization, and accounting setting.

path Parameters
venueId
required
string

Responses

Response samples

Content type
{
  • "acctCommonsFirstServer": "string",
  • "acctCommonsLevel": "string",
  • "acctCommonsSecondServer": "string",
  • "acctCommonsThirdServer": "string",
  • "acctEnabledCommand": true,
  • "acctEnabledExec": true,
  • "acctExecFirstServer": "string",
  • "acctExecSecondServer": "string",
  • "acctExecThirdServer": "string",
  • "authnEnableTelnet": true,
  • "authnEnabledSsh": true,
  • "authnFirstPref": "string",
  • "authnFourthPref": "string",
  • "authnSecondPref": "string",
  • "authnThirdPref": "string",
  • "authzCommonsFirstServer": "string",
  • "authzCommonsLevel": "string",
  • "authzCommonsSecondServer": "string",
  • "authzCommonsThirdServer": "string",
  • "authzEnabledCommand": true,
  • "authzEnabledExec": true,
  • "authzExecFirstServer": "string",
  • "authzExecSecondServer": "string",
  • "authzExecThirdServer": "string",
  • "id": "string"
}

Update AAA Setting

Update authentication, authorization, and accounting setting by id. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
Request Body schema:
required
acctCommonsFirstServer
string
acctCommonsLevel
string
acctCommonsSecondServer
string
acctCommonsThirdServer
string
acctEnabledCommand
boolean
acctEnabledExec
boolean
acctExecFirstServer
string
acctExecSecondServer
string
acctExecThirdServer
string
authnEnableTelnet
boolean
authnEnabledSsh
boolean
authnFirstPref
string
authnFourthPref
string
authnSecondPref
string
authnThirdPref
string
authzCommonsFirstServer
string
authzCommonsLevel
string
authzCommonsSecondServer
string
authzCommonsThirdServer
string
authzEnabledCommand
boolean
authzEnabledExec
boolean
authzExecFirstServer
string
authzExecSecondServer
string
authzExecThirdServer
string
id
string

Responses

Request samples

Content type
{
  • "acctCommonsFirstServer": "string",
  • "acctCommonsLevel": "string",
  • "acctCommonsSecondServer": "string",
  • "acctCommonsThirdServer": "string",
  • "acctEnabledCommand": true,
  • "acctEnabledExec": true,
  • "acctExecFirstServer": "string",
  • "acctExecSecondServer": "string",
  • "acctExecThirdServer": "string",
  • "authnEnableTelnet": true,
  • "authnEnabledSsh": true,
  • "authnFirstPref": "string",
  • "authnFourthPref": "string",
  • "authnSecondPref": "string",
  • "authnThirdPref": "string",
  • "authzCommonsFirstServer": "string",
  • "authzCommonsLevel": "string",
  • "authzCommonsSecondServer": "string",
  • "authzCommonsThirdServer": "string",
  • "authzEnabledCommand": true,
  • "authzEnabledExec": true,
  • "authzExecFirstServer": "string",
  • "authzExecSecondServer": "string",
  • "authzExecThirdServer": "string",
  • "id": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Update AAA Setting Deprecated

Update authentication, authorization, and accounting setting by id. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
aaaSettingId
required
string
Request Body schema:
required
acctCommonsFirstServer
string
acctCommonsLevel
string
acctCommonsSecondServer
string
acctCommonsThirdServer
string
acctEnabledCommand
boolean
acctEnabledExec
boolean
acctExecFirstServer
string
acctExecSecondServer
string
acctExecThirdServer
string
authnEnableTelnet
boolean
authnEnabledSsh
boolean
authnFirstPref
string
authnFourthPref
string
authnSecondPref
string
authnThirdPref
string
authzCommonsFirstServer
string
authzCommonsLevel
string
authzCommonsSecondServer
string
authzCommonsThirdServer
string
authzEnabledCommand
boolean
authzEnabledExec
boolean
authzExecFirstServer
string
authzExecSecondServer
string
authzExecThirdServer
string

Responses

Request samples

Content type
{
  • "acctCommonsFirstServer": "string",
  • "acctCommonsLevel": "string",
  • "acctCommonsSecondServer": "string",
  • "acctCommonsThirdServer": "string",
  • "acctEnabledCommand": true,
  • "acctEnabledExec": true,
  • "acctExecFirstServer": "string",
  • "acctExecSecondServer": "string",
  • "acctExecThirdServer": "string",
  • "authnEnableTelnet": true,
  • "authnEnabledSsh": true,
  • "authnFirstPref": "string",
  • "authnFourthPref": "string",
  • "authnSecondPref": "string",
  • "authnThirdPref": "string",
  • "authzCommonsFirstServer": "string",
  • "authzCommonsLevel": "string",
  • "authzCommonsSecondServer": "string",
  • "authzCommonsThirdServer": "string",
  • "authzEnabledCommand": true,
  • "authzEnabledExec": true,
  • "authzExecFirstServer": "string",
  • "authzExecSecondServer": "string",
  • "authzExecThirdServer": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Venue Template AAA Server

Manage Venue Template AAA (authentication, authorization, and accounting) Servers.

Delete Venue Template AAA Servers Deprecated

Delete venue template's multiple authentication, authorization, and accounting servers.

Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Query Venue Template AAA Servers Deprecated

List of venue template's authentication, authorization, and accounting servers.

Request Body schema:
required
fields
Array of strings
page
integer <int32>
pageSize
integer <int32>
searchString
string
searchTargetFields
Array of strings
serverType
string
Enum: "__NULL" "RADIUS" "TACACS_PLUS" "LOCAL" "NONE_TYPE"
sortField
string
sortOrder
string
Enum: "ASC" "DESC"
venueId
string

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "serverType": "__NULL",
  • "sortField": "string",
  • "sortOrder": "ASC",
  • "venueId": "string"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Venue Template AAA Server Deprecated

Delete venue template's authentication, authorization, and accounting server by id.

path Parameters
aaaServerId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Venue Template AAA Server Deprecated

Get venue template's authentication, authorization, and accounting server.

path Parameters
aaaServerId
required
string

Responses

Response samples

Content type
{
  • "aaaServerViewList": [
    ],
  • "acctPort": 0,
  • "authPort": 0,
  • "id": "string",
  • "ip": "string",
  • "level": "UNSPECIFIED",
  • "name": "string",
  • "password": "string",
  • "purpose": "UNSPECIFIED",
  • "secret": "string",
  • "serverType": "__NULL",
  • "switchCountInVenue": 0,
  • "syncedPasswordSwitchCount": 0,
  • "username": "string"
}

Delete Venue Template AAA Servers

Delete venue template's multiple authentication, authorization, and accounting servers.

path Parameters
venueId
required
string
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Add Venue Template AAA Server

Add venue template's authentication, authorization, and accounting server. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
Request Body schema:
required
acctPort
integer <int32> [ 0 .. 65535 ]
authPort
integer <int32> [ 0 .. 65535 ]
encryptedPassword
string
id
string
ip
string^([1-9]|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])(\.([0...
level
string
Enum: "UNSPECIFIED" "READ_WRITE" "PORT_CONFIG" "READ_ONLY" "LEVEL_NONE"
name
string [ 2 .. 64 ] characters
password
string [ 8 .. 64 ] characters
purpose
string
Enum: "UNSPECIFIED" "DEFAULT" "AUTHENTICATION_ONLY" "AUTHORIZATION_ONLY" "ACCOUNTING_ONLY"
secret
string [ 1 .. 64 ] characters
serverType
string
Enum: "__NULL" "RADIUS" "TACACS_PLUS" "LOCAL" "NONE_TYPE"
username
string [ 2 .. 48 ] characters

Responses

Request samples

Content type
{
  • "acctPort": 65535,
  • "authPort": 65535,
  • "encryptedPassword": "string",
  • "id": "string",
  • "ip": "string",
  • "level": "UNSPECIFIED",
  • "name": "string",
  • "password": "stringst",
  • "purpose": "UNSPECIFIED",
  • "secret": "string",
  • "serverType": "__NULL",
  • "username": "string"
}

Response samples

Content type
{
  • "aaaServerViewList": [
    ],
  • "acctPort": 0,
  • "authPort": 0,
  • "id": "string",
  • "ip": "string",
  • "level": "UNSPECIFIED",
  • "name": "string",
  • "password": "string",
  • "purpose": "UNSPECIFIED",
  • "secret": "string",
  • "serverType": "__NULL",
  • "switchCountInVenue": 0,
  • "syncedPasswordSwitchCount": 0,
  • "username": "string"
}

Query Venue Template AAA Servers

List of venue template's authentication, authorization, and accounting servers.

path Parameters
venueId
required
string
Request Body schema:
required
fields
Array of strings
page
integer <int32>
pageSize
integer <int32>
searchString
string
searchTargetFields
Array of strings
serverType
string
Enum: "__NULL" "RADIUS" "TACACS_PLUS" "LOCAL" "NONE_TYPE"
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "serverType": "__NULL",
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Venue Template AAA Server

Delete venue template's authentication, authorization, and accounting server by id.

path Parameters
venueId
required
string
aaaServerId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Venue Template AAA Server

Get venue template's authentication, authorization, and accounting server.

path Parameters
venueId
required
string
aaaServerId
required
string

Responses

Response samples

Content type
{
  • "acctPort": 0,
  • "authPort": 0,
  • "id": "string",
  • "ip": "string",
  • "level": "UNSPECIFIED",
  • "name": "string",
  • "password": "string",
  • "purpose": "UNSPECIFIED",
  • "secret": "string",
  • "serverType": "__NULL",
  • "username": "string"
}

Update Venue Template AAA Server

Update venue template's authentication, authorization, and accounting server by id. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
aaaServerId
required
string
Request Body schema:
required
acctPort
integer <int32> [ 0 .. 65535 ]
authPort
integer <int32> [ 0 .. 65535 ]
encryptedPassword
string
id
string
ip
string^([1-9]|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])(\.([0...
level
string
Enum: "UNSPECIFIED" "READ_WRITE" "PORT_CONFIG" "READ_ONLY" "LEVEL_NONE"
name
string [ 2 .. 64 ] characters
password
string [ 8 .. 64 ] characters
purpose
string
Enum: "UNSPECIFIED" "DEFAULT" "AUTHENTICATION_ONLY" "AUTHORIZATION_ONLY" "ACCOUNTING_ONLY"
secret
string [ 1 .. 64 ] characters
serverType
string
Enum: "__NULL" "RADIUS" "TACACS_PLUS" "LOCAL" "NONE_TYPE"
username
string [ 2 .. 48 ] characters

Responses

Request samples

Content type
{
  • "acctPort": 65535,
  • "authPort": 65535,
  • "encryptedPassword": "string",
  • "id": "string",
  • "ip": "string",
  • "level": "UNSPECIFIED",
  • "name": "string",
  • "password": "stringst",
  • "purpose": "UNSPECIFIED",
  • "secret": "string",
  • "serverType": "__NULL",
  • "username": "string"
}

Response samples

Content type
{
  • "aaaServerViewList": [
    ],
  • "acctPort": 0,
  • "authPort": 0,
  • "id": "string",
  • "ip": "string",
  • "level": "UNSPECIFIED",
  • "name": "string",
  • "password": "string",
  • "purpose": "UNSPECIFIED",
  • "secret": "string",
  • "serverType": "__NULL",
  • "switchCountInVenue": 0,
  • "syncedPasswordSwitchCount": 0,
  • "username": "string"
}

Venue Template AAA Setting

Manage Venue Template AAA (authentication, authorization, and accounting) Settings.

Retrieve Venue Template AAA Setting

Retrieve venue template's authentication, authorization, and accounting setting.

path Parameters
venueId
required
string

Responses

Response samples

Content type
{
  • "acctCommonsFirstServer": "string",
  • "acctCommonsLevel": "string",
  • "acctCommonsSecondServer": "string",
  • "acctCommonsThirdServer": "string",
  • "acctEnabledCommand": true,
  • "acctEnabledExec": true,
  • "acctExecFirstServer": "string",
  • "acctExecSecondServer": "string",
  • "acctExecThirdServer": "string",
  • "authnEnableTelnet": true,
  • "authnEnabledSsh": true,
  • "authnFirstPref": "string",
  • "authnFourthPref": "string",
  • "authnSecondPref": "string",
  • "authnThirdPref": "string",
  • "authzCommonsFirstServer": "string",
  • "authzCommonsLevel": "string",
  • "authzCommonsSecondServer": "string",
  • "authzCommonsThirdServer": "string",
  • "authzEnabledCommand": true,
  • "authzEnabledExec": true,
  • "authzExecFirstServer": "string",
  • "authzExecSecondServer": "string",
  • "authzExecThirdServer": "string",
  • "id": "string"
}

Update Venue Template AAA Setting

Update venue template's authentication, authorization, and accounting setting by id. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
Request Body schema:
required
acctCommonsFirstServer
string
acctCommonsLevel
string
acctCommonsSecondServer
string
acctCommonsThirdServer
string
acctEnabledCommand
boolean
acctEnabledExec
boolean
acctExecFirstServer
string
acctExecSecondServer
string
acctExecThirdServer
string
authnEnableTelnet
boolean
authnEnabledSsh
boolean
authnFirstPref
string
authnFourthPref
string
authnSecondPref
string
authnThirdPref
string
authzCommonsFirstServer
string
authzCommonsLevel
string
authzCommonsSecondServer
string
authzCommonsThirdServer
string
authzEnabledCommand
boolean
authzEnabledExec
boolean
authzExecFirstServer
string
authzExecSecondServer
string
authzExecThirdServer
string
id
string

Responses

Request samples

Content type
{
  • "acctCommonsFirstServer": "string",
  • "acctCommonsLevel": "string",
  • "acctCommonsSecondServer": "string",
  • "acctCommonsThirdServer": "string",
  • "acctEnabledCommand": true,
  • "acctEnabledExec": true,
  • "acctExecFirstServer": "string",
  • "acctExecSecondServer": "string",
  • "acctExecThirdServer": "string",
  • "authnEnableTelnet": true,
  • "authnEnabledSsh": true,
  • "authnFirstPref": "string",
  • "authnFourthPref": "string",
  • "authnSecondPref": "string",
  • "authnThirdPref": "string",
  • "authzCommonsFirstServer": "string",
  • "authzCommonsLevel": "string",
  • "authzCommonsSecondServer": "string",
  • "authzCommonsThirdServer": "string",
  • "authzEnabledCommand": true,
  • "authzEnabledExec": true,
  • "authzExecFirstServer": "string",
  • "authzExecSecondServer": "string",
  • "authzExecThirdServer": "string",
  • "id": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Update Venue Template AAA Setting Deprecated

Update venue template's authentication, authorization, and accounting setting by id. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
aaaSettingId
required
string
Request Body schema:
required
acctCommonsFirstServer
string
acctCommonsLevel
string
acctCommonsSecondServer
string
acctCommonsThirdServer
string
acctEnabledCommand
boolean
acctEnabledExec
boolean
acctExecFirstServer
string
acctExecSecondServer
string
acctExecThirdServer
string
authnEnableTelnet
boolean
authnEnabledSsh
boolean
authnFirstPref
string
authnFourthPref
string
authnSecondPref
string
authnThirdPref
string
authzCommonsFirstServer
string
authzCommonsLevel
string
authzCommonsSecondServer
string
authzCommonsThirdServer
string
authzEnabledCommand
boolean
authzEnabledExec
boolean
authzExecFirstServer
string
authzExecSecondServer
string
authzExecThirdServer
string

Responses

Request samples

Content type
{
  • "acctCommonsFirstServer": "string",
  • "acctCommonsLevel": "string",
  • "acctCommonsSecondServer": "string",
  • "acctCommonsThirdServer": "string",
  • "acctEnabledCommand": true,
  • "acctEnabledExec": true,
  • "acctExecFirstServer": "string",
  • "acctExecSecondServer": "string",
  • "acctExecThirdServer": "string",
  • "authnEnableTelnet": true,
  • "authnEnabledSsh": true,
  • "authnFirstPref": "string",
  • "authnFourthPref": "string",
  • "authnSecondPref": "string",
  • "authnThirdPref": "string",
  • "authzCommonsFirstServer": "string",
  • "authzCommonsLevel": "string",
  • "authzCommonsSecondServer": "string",
  • "authzCommonsThirdServer": "string",
  • "authzEnabledCommand": true,
  • "authzEnabledExec": true,
  • "authzExecFirstServer": "string",
  • "authzExecSecondServer": "string",
  • "authzExecThirdServer": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Switch Static Routes

Manage static routes.

Delete Static Routes Deprecated

Delete multiple static routes.

Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Static Route Deprecated

Delete the specified static route.

path Parameters
staticRouteId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Static Route Deprecated

Get the specified static route.

path Parameters
staticRouteId
required
string

Responses

Response samples

Content type
{
  • "adminDistance": 1,
  • "destinationIp": "string",
  • "id": "string",
  • "nextHop": "string",
  • "staticRouteViewList": [
    ]
}

Update Static Route Deprecated

Update the specified static route.

path Parameters
staticRouteId
required
string
Request Body schema:
required
adminDistance
integer <int32> [ 1 .. 255 ]
destinationIp
string"^(\\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]...
id
string
nextHop
string^(\\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|...
uniqueValue
string

Responses

Request samples

Content type
{
  • "adminDistance": 1,
  • "destinationIp": "string",
  • "id": "string",
  • "nextHop": "string",
  • "uniqueValue": "string"
}

Response samples

Content type
{
  • "adminDistance": 1,
  • "destinationIp": "string",
  • "id": "string",
  • "nextHop": "string",
  • "staticRouteViewList": [
    ]
}

Get Static Routes Deprecated

Get multiple static routes of the switch.

path Parameters
switchId
required
string

Responses

Response samples

Content type
{
  • "adminDistance": 1,
  • "destinationIp": "string",
  • "id": "string",
  • "nextHop": "string",
  • "staticRouteViewList": [
    ]
}

Add Static Route Deprecated

Add multiple static routes of the switch.

path Parameters
switchId
required
string
Request Body schema:
required
Array
adminDistance
integer <int32> [ 1 .. 255 ]
destinationIp
string"^(\\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]...
id
string
nextHop
string^(\\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|...
uniqueValue
string

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "adminDistance": 1,
  • "destinationIp": "string",
  • "id": "string",
  • "nextHop": "string",
  • "staticRouteViewList": [
    ]
}

Delete Static Routes

Delete multiple static routes.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Static Routes

Get multiple static routes of the switch.

path Parameters
venueId
required
string
switchId
required
string

Responses

Response samples

Content type
[
  • {
    }
]

Add Static Route

Add multiple static routes of the switch.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
Array
adminDistance
integer <int32> [ 1 .. 255 ]
destinationIp
string^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...
id
string
nextHop
string^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Static Route

Delete the specified static route.

path Parameters
venueId
required
string
switchId
required
string
staticRouteId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Static Route

Get the specified static route.

path Parameters
venueId
required
string
switchId
required
string
staticRouteId
required
string

Responses

Response samples

Content type
{
  • "adminDistance": 1,
  • "destinationIp": "string",
  • "id": "string",
  • "nextHop": "string"
}

Update Static Route

Update the specified static route.

path Parameters
venueId
required
string
switchId
required
string
staticRouteId
required
string
Request Body schema:
required
adminDistance
integer <int32> [ 1 .. 255 ]
destinationIp
string^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...
id
string
nextHop
string^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...

Responses

Request samples

Content type
{
  • "adminDistance": 1,
  • "destinationIp": "string",
  • "id": "string",
  • "nextHop": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Venue Switch Setting

Manage a switch's venue-level settings.

Delete Venue Switch Settings Deprecated

Delete switch settings of the venue.

path Parameters
venueId
required
string

Responses

Response samples

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

Get Venue Switch Setting

Get the switch settings of the venue.

path Parameters
venueId
required
string

Responses

Response samples

Content type
{
  • "cliApplied": true,
  • "dns": [
    ],
  • "id": "string",
  • "name": "string",
  • "profileId": [
    ],
  • "switchLoginPassword": "string",
  • "switchLoginUsername": "string",
  • "syslogEnabled": true,
  • "syslogPrimaryServer": "string",
  • "syslogSecondaryServer": "string"
}

Update Venue Switch Setting

Update the switch settings of the venue. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
Request Body schema:
required
dns
Array of strings
id
string
profileId
Array of strings
syslogEnabled
boolean
syslogPrimaryServer
string
syslogSecondaryServer
string

Responses

Request samples

Content type
{
  • "dns": [
    ],
  • "id": "string",
  • "profileId": [
    ],
  • "syslogEnabled": true,
  • "syslogPrimaryServer": "string",
  • "syslogSecondaryServer": "string"
}

Response samples

Content type
{
  • "cliApplied": true,
  • "dns": [
    ],
  • "id": "string",
  • "name": "string",
  • "profileId": [
    ],
  • "switchLoginPassword": "string",
  • "switchLoginUsername": "string",
  • "syslogEnabled": true,
  • "syslogPrimaryServer": "string",
  • "syslogSecondaryServer": "string"
}

ICX Switch

Manage ICX Switches.

Delete Stack Member Deprecated

Delete stack member.

path Parameters
stackSwitchSerialNumber
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete ICX Switches Deprecated

Delete multiple ICX switches.

Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get ICX Switches Deprecated

List of tenant's ICX switches.

Responses

Response samples

Content type
{
  • "defaultGateway": "string",
  • "description": "string",
  • "dhcpClientEnabled": true,
  • "dhcpServerEnabled": true,
  • "enableStack": true,
  • "firmwareVersion": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "initialVlanId": 0,
  • "ipAddress": "string",
  • "ipAddressInterface": "string",
  • "ipAddressInterfaceType": "NONE",
  • "ipAddressType": "static",
  • "jumboMode": true,
  • "lastDataSyncTime": 0,
  • "lastDataSyncTriggerTime": 0,
  • "name": "string",
  • "position": {
    },
  • "previousMembers": [
    ],
  • "rearModule": "string",
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "spanningTreePriority": 0,
  • "specifiedType": "AUTO",
  • "stackConfigTimestamp": "string",
  • "stackMembers": [
    ],
  • "subnetMask": "string",
  • "syncDataEndTime": 0,
  • "syncDataId": "string",
  • "syncDataStartTime": 0,
  • "tags": "string",
  • "trustPorts": [
    ],
  • "venueId": "string"
}

Add ICX Switches Deprecated

Add multiple ICX switches. Use activity API with request id to get the status update.

Request Body schema:
required
Array
defaultGateway
string
description
string
dhcpClientEnabled
boolean
dhcpServerEnabled
boolean
displayOfStack
string
enableStack
boolean
firmwareVersion
string
id
string
igmpSnooping
string
initialVlanId
integer <int32>
ipAddress
string
ipAddressInterface
string
ipAddressInterfaceType
string
ipAddressType
string
Enum: "static" "dynamic"
jumboMode
boolean
lastDataSyncTime
string <date-time>
lastDataSyncTriggerTime
string <date-time>
model
string
Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" "ICX8200-24" "ICX8200-24P" "ICX8200-24F" "ICX8200-24FX" "ICX8200-24ZP" "ICX8200-48" "ICX8200-48F" "ICX8200-48P" "ICX8200-48PF" "ICX8200-48PF2" "ICX8200-48ZP2" "ICX8200-C08P" "ICX8200-C08PDC" "ICX8200-C08PF" "ICX8200-C08PT" "ICX8200-C08ZP" "ICX8100-24" "ICX8100-24P" "ICX8100-48" "ICX8100-48P" "ICX8100-C08PF"
name
string
position
string
previousMembers
Array of strings unique
rearModule
string
softDeletedDate
string <date-time>
spanningTreePriority
integer <int32>
specifiedType
string
Enum: "AUTO" "SWITCH" "ROUTER"
stackConfigTimestamp
string
Array of objects (Switch_Service_API_&_Model_Documentation_StackMembers)
Array of objects (Switch_Service_API_&_Model_Documentation_StackMembers)
subnetMask
string
syncDataEndTime
string <date-time>
syncDataId
string
syncDataStartTime
string <date-time>
tags
string
trustPorts
Array of strings
venueId
string
vlanCustomize
boolean

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Create Multiple Device Requests Deprecated

Execute sync venues admin password on multiple switch devices, switch id list should be provided on the request body.

Request Body schema:
required
deviceRequestAction
string
Enum: "sync" "reboot" "syncAdminPassword"
switchIdList
Array of strings

Responses

Request samples

Content type
{
  • "deviceRequestAction": "sync",
  • "switchIdList": [
    ]
}

Response samples

Content type
{
  • "id": "string",
  • "switchIdList": [
    ],
  • "tenantId": "string"
}

Delete ICX Switch Deprecated

Delete ICX switch by id.

path Parameters
switchId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get ICX Switch Deprecated

Get ICX switch by id.

path Parameters
switchId
required
string

Responses

Response samples

Content type
{
  • "defaultGateway": "string",
  • "description": "string",
  • "dhcpClientEnabled": true,
  • "dhcpServerEnabled": true,
  • "enableStack": true,
  • "firmwareVersion": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "initialVlanId": 0,
  • "ipAddress": "string",
  • "ipAddressInterface": "string",
  • "ipAddressInterfaceType": "NONE",
  • "ipAddressType": "static",
  • "jumboMode": true,
  • "lastDataSyncTime": 0,
  • "lastDataSyncTriggerTime": 0,
  • "name": "string",
  • "position": {
    },
  • "previousMembers": [
    ],
  • "rearModule": "string",
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "spanningTreePriority": 0,
  • "specifiedType": "AUTO",
  • "stackConfigTimestamp": "string",
  • "stackMembers": [
    ],
  • "subnetMask": "string",
  • "syncDataEndTime": 0,
  • "syncDataId": "string",
  • "syncDataStartTime": 0,
  • "tags": "string",
  • "trustPorts": [
    ],
  • "venueId": "string"
}

Update ICX Switch Deprecated

Update ICX switch. Use activity API with request id to get the status update.

path Parameters
switchId
required
string
Request Body schema:
required
defaultGateway
string
description
string
dhcpClientEnabled
boolean
dhcpServerEnabled
boolean
displayOfStack
string
enableStack
boolean
firmwareVersion
string
id
string
igmpSnooping
string
initialVlanId
integer <int32>
ipAddress
string
ipAddressInterface
string
ipAddressInterfaceType
string
ipAddressType
string
Enum: "static" "dynamic"
jumboMode
boolean
lastDataSyncTime
string <date-time>
lastDataSyncTriggerTime
string <date-time>
model
string
Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" "ICX8200-24" "ICX8200-24P" "ICX8200-24F" "ICX8200-24FX" "ICX8200-24ZP" "ICX8200-48" "ICX8200-48F" "ICX8200-48P" "ICX8200-48PF" "ICX8200-48PF2" "ICX8200-48ZP2" "ICX8200-C08P" "ICX8200-C08PDC" "ICX8200-C08PF" "ICX8200-C08PT" "ICX8200-C08ZP" "ICX8100-24" "ICX8100-24P" "ICX8100-48" "ICX8100-48P" "ICX8100-C08PF"
name
string
position
string
previousMembers
Array of strings unique
rearModule
string
softDeletedDate
string <date-time>
spanningTreePriority
integer <int32>
specifiedType
string
Enum: "AUTO" "SWITCH" "ROUTER"
stackConfigTimestamp
string
Array of objects (Switch_Service_API_&_Model_Documentation_StackMembers)
Array of objects (Switch_Service_API_&_Model_Documentation_StackMembers)
subnetMask
string
syncDataEndTime
string <date-time>
syncDataId
string
syncDataStartTime
string <date-time>
tags
string
trustPorts
Array of strings
venueId
string
vlanCustomize
boolean

Responses

Request samples

Content type
{
  • "defaultGateway": "string",
  • "description": "string",
  • "dhcpClientEnabled": true,
  • "dhcpServerEnabled": true,
  • "displayOfStack": "string",
  • "enableStack": true,
  • "firmwareVersion": "string",
  • "id": "string",
  • "igmpSnooping": "string",
  • "initialVlanId": 0,
  • "ipAddress": "string",
  • "ipAddressInterface": "string",
  • "ipAddressInterfaceType": "string",
  • "ipAddressType": "static",
  • "jumboMode": true,
  • "lastDataSyncTime": "2019-08-24T14:15:22Z",
  • "lastDataSyncTriggerTime": "2019-08-24T14:15:22Z",
  • "model": "ICX7150-24",
  • "name": "string",
  • "position": "string",
  • "previousMembers": [
    ],
  • "rearModule": "string",
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "spanningTreePriority": 0,
  • "specifiedType": "AUTO",
  • "stackConfigTimestamp": "string",
  • "stackMembers": [
    ],
  • "stackMembersAndFilterActiveId": [
    ],
  • "subnetMask": "string",
  • "syncDataEndTime": "2019-08-24T14:15:22Z",
  • "syncDataId": "string",
  • "syncDataStartTime": "2019-08-24T14:15:22Z",
  • "tags": "string",
  • "trustPorts": [
    ],
  • "venueId": "string",
  • "vlanCustomize": true
}

Response samples

Content type
{
  • "defaultGateway": "string",
  • "description": "string",
  • "dhcpClientEnabled": true,
  • "dhcpServerEnabled": true,
  • "enableStack": true,
  • "firmwareVersion": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "initialVlanId": 0,
  • "ipAddress": "string",
  • "ipAddressInterface": "string",
  • "ipAddressInterfaceType": "NONE",
  • "ipAddressType": "static",
  • "jumboMode": true,
  • "lastDataSyncTime": 0,
  • "lastDataSyncTriggerTime": 0,
  • "name": "string",
  • "position": {
    },
  • "previousMembers": [
    ],
  • "rearModule": "string",
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "spanningTreePriority": 0,
  • "specifiedType": "AUTO",
  • "stackConfigTimestamp": "string",
  • "stackMembers": [
    ],
  • "subnetMask": "string",
  • "syncDataEndTime": 0,
  • "syncDataId": "string",
  • "syncDataStartTime": 0,
  • "tags": "string",
  • "trustPorts": [
    ],
  • "venueId": "string"
}

Sync/Reboot ICX Device Deprecated

Execute sync or reboot command on the specified switch device, no need to provide switch id list on the request body.

path Parameters
switchId
required
string
Request Body schema:
required
deviceRequestAction
string
Enum: "sync" "reboot" "syncAdminPassword"
switchIdList
Array of strings

Responses

Request samples

Content type
{
  • "deviceRequestAction": "sync",
  • "switchIdList": [
    ]
}

Response samples

Content type
{
  • "errors": [
    ],
  • "requestId": "string"
}

Create Multiple Device Requests

Execute sync venues admin password on multiple switch devices, switch id list should be provided on the request body.

path Parameters
venueId
required
string
Request Body schema:
required
deviceRequestAction
string
Enum: "sync" "reboot" "syncAdminPassword"
switchIdList
Array of strings

Responses

Request samples

Content type
{
  • "deviceRequestAction": "sync",
  • "switchIdList": [
    ]
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Stack Member

Delete stack member.

path Parameters
venueId
required
string
stackSwitchSerialNumber
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete ICX Switches

Delete multiple ICX switches.

path Parameters
venueId
required
string
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Retrieve ICX Switches

Retrieve list of venues' ICX switches.

path Parameters
venueId
required
string

Responses

Response samples

Content type
{
  • "defaultGateway": "string",
  • "description": "string",
  • "dhcpClientEnabled": true,
  • "dhcpServerEnabled": true,
  • "enableStack": true,
  • "firmwareVersion": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "initialVlanId": 0,
  • "ipAddress": "string",
  • "ipAddressInterface": "string",
  • "ipAddressInterfaceType": "NONE",
  • "ipAddressType": "static",
  • "jumboMode": true,
  • "lastDataSyncTime": 0,
  • "lastDataSyncTriggerTime": 0,
  • "name": "string",
  • "position": {
    },
  • "previousMembers": [
    ],
  • "rearModule": "string",
  • "softDeletedDate": "2019-08-24T14:15:22Z",
  • "spanningTreePriority": 0,
  • "specifiedType": "AUTO",
  • "stackConfigTimestamp": "string",
  • "stackMembers": [
    ],
  • "subnetMask": "string",
  • "syncDataEndTime": 0,
  • "syncDataId": "string",
  • "syncDataStartTime": 0,
  • "tags": "string",
  • "trustPorts": [
    ],
  • "venueId": "string"
}

Add ICX Switches

Add multiple ICX switches. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
Request Body schema:
required
Array
defaultGateway
string
description
string
dhcpClientEnabled
boolean
dhcpServerEnabled
boolean
enableStack
boolean
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
initialVlanId
integer <int32>
ipAddress
string
ipAddressInterface
string
ipAddressInterfaceType
string
Enum: "NONE" "PORT" "VE" "MANAGEMENT"
ipAddressType
string
Enum: "static" "dynamic"
jumboMode
boolean
name
string
rearModule
string
spanningTreePriority
integer <int32>
specifiedType
string
Enum: "AUTO" "SWITCH" "ROUTER"
Array of objects (Switch_Service_API_&_Model_Documentation_StackMembersViewV1001)
subnetMask
string
vlanCustomize
boolean

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete ICX Switch

Delete ICX switch by id.

path Parameters
venueId
required
string
switchId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get ICX Switch

Get ICX switch by id.

path Parameters
venueId
required
string
switchId
required
string

Responses

Response samples

Content type
{
  • "defaultGateway": "string",
  • "description": "string",
  • "dhcpClientEnabled": true,
  • "dhcpServerEnabled": true,
  • "enableStack": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "initialVlanId": 0,
  • "ipAddress": "string",
  • "ipAddressInterface": "string",
  • "ipAddressInterfaceType": "NONE",
  • "ipAddressType": "static",
  • "jumboMode": true,
  • "name": "string",
  • "rearModule": "string",
  • "spanningTreePriority": 0,
  • "specifiedType": "AUTO",
  • "stackMembers": [
    ],
  • "subnetMask": "string",
  • "vlanCustomize": true
}

Add ICX Switch

Add an ICX switch. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
defaultGateway
string
description
string
dhcpClientEnabled
boolean
dhcpServerEnabled
boolean
enableStack
boolean
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
initialVlanId
integer <int32>
ipAddress
string
ipAddressInterface
string
ipAddressInterfaceType
string
Enum: "NONE" "PORT" "VE" "MANAGEMENT"
ipAddressType
string
Enum: "static" "dynamic"
jumboMode
boolean
name
string
rearModule
string
spanningTreePriority
integer <int32>
specifiedType
string
Enum: "AUTO" "SWITCH" "ROUTER"
Array of objects (Switch_Service_API_&_Model_Documentation_StackMembersViewV1001)
subnetMask
string
vlanCustomize
boolean

Responses

Request samples

Content type
{
  • "defaultGateway": "string",
  • "description": "string",
  • "dhcpClientEnabled": true,
  • "dhcpServerEnabled": true,
  • "enableStack": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "initialVlanId": 0,
  • "ipAddress": "string",
  • "ipAddressInterface": "string",
  • "ipAddressInterfaceType": "NONE",
  • "ipAddressType": "static",
  • "jumboMode": true,
  • "name": "string",
  • "rearModule": "string",
  • "spanningTreePriority": 0,
  • "specifiedType": "AUTO",
  • "stackMembers": [
    ],
  • "subnetMask": "string",
  • "vlanCustomize": true
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Update ICX Switch

Update ICX switch. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
defaultGateway
string
description
string
dhcpClientEnabled
boolean
dhcpServerEnabled
boolean
enableStack
boolean
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
initialVlanId
integer <int32>
ipAddress
string
ipAddressInterface
string
ipAddressInterfaceType
string
Enum: "NONE" "PORT" "VE" "MANAGEMENT"
ipAddressType
string
Enum: "static" "dynamic"
jumboMode
boolean
name
string
rearModule
string
spanningTreePriority
integer <int32>
specifiedType
string
Enum: "AUTO" "SWITCH" "ROUTER"
Array of objects (Switch_Service_API_&_Model_Documentation_StackMembersViewV1001)
subnetMask
string
vlanCustomize
boolean

Responses

Request samples

Content type
{
  • "defaultGateway": "string",
  • "description": "string",
  • "dhcpClientEnabled": true,
  • "dhcpServerEnabled": true,
  • "enableStack": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "initialVlanId": 0,
  • "ipAddress": "string",
  • "ipAddressInterface": "string",
  • "ipAddressInterfaceType": "NONE",
  • "ipAddressType": "static",
  • "jumboMode": true,
  • "name": "string",
  • "rearModule": "string",
  • "spanningTreePriority": 0,
  • "specifiedType": "AUTO",
  • "stackMembers": [
    ],
  • "subnetMask": "string",
  • "vlanCustomize": true
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Sync/Reboot ICX Device

Execute sync or reboot command on the specified switch device, no need to provide switch id list on the request body.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
deviceRequestAction
string
Enum: "sync" "reboot" "syncAdminPassword"
switchIdList
Array of strings

Responses

Request samples

Content type
{
  • "deviceRequestAction": "sync",
  • "switchIdList": [
    ]
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Update Switch Position

Update ICX switch position in the floor plan

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
floorPlanId
string
xPercent
number <float>
yPercent
number <float>

Responses

Request samples

Content type
{
  • "floorPlanId": "string",
  • "xPercent": 0.1,
  • "yPercent": 0.1
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Web Authentication Page Template

Manage web authentication page template.

Add Web Authentication Template

Add web authentication page template.

Request Body schema:
required
id
string [ 0 .. 37 ] characters
name
required
string [ 0 .. 32 ] characters
tag
string [ 0 .. 255 ] characters
tenantId
string
webAuthCustomBottom
string [ 0 .. 255 ] characters
webAuthCustomLoginButton
string [ 0 .. 32 ] characters
webAuthCustomTitle
string [ 0 .. 128 ] characters
webAuthCustomTop
string [ 0 .. 255 ] characters
webAuthPasswordLabel
string [ 0 .. 32 ] characters

Responses

Request samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tag": "string",
  • "tenantId": "string",
  • "webAuthCustomBottom": "string",
  • "webAuthCustomLoginButton": "string",
  • "webAuthCustomTitle": "string",
  • "webAuthCustomTop": "string",
  • "webAuthPasswordLabel": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "switchCount": 0,
  • "switchVenueInfos": [
    ],
  • "tag": "string",
  • "venueCount": 0,
  • "webAuthCustomBottom": "string",
  • "webAuthCustomLoginButton": "string",
  • "webAuthCustomTitle": "string",
  • "webAuthCustomTop": "string",
  • "webAuthPageTemplateViewList": [
    ],
  • "webAuthPasswordLabel": "string",
  • "webAuthUserIdLabel": "string"
}

Query Web Authentication Templates

List of tenant's web authentication page templates.

Request Body schema:
required
fields
Array of strings
page
integer <int32>
pageSize
integer <int32>
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Web Authentication Template

Delete web authentication page template by id.

path Parameters
templateId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Web Authentication Template

Get a web authentication page template by id.

path Parameters
templateId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "switchCount": 0,
  • "switchVenueInfos": [
    ],
  • "tag": "string",
  • "venueCount": 0,
  • "webAuthCustomBottom": "string",
  • "webAuthCustomLoginButton": "string",
  • "webAuthCustomTitle": "string",
  • "webAuthCustomTop": "string",
  • "webAuthPageTemplateViewList": [
    ],
  • "webAuthPasswordLabel": "string",
  • "webAuthUserIdLabel": "string"
}

Update Web Authentication Template

Update web authentication page template by id.

path Parameters
templateId
required
string
Request Body schema:
required
id
string [ 0 .. 37 ] characters
name
required
string [ 0 .. 32 ] characters
tag
string [ 0 .. 255 ] characters
tenantId
string
webAuthCustomBottom
string [ 0 .. 255 ] characters
webAuthCustomLoginButton
string [ 0 .. 32 ] characters
webAuthCustomTitle
string [ 0 .. 128 ] characters
webAuthCustomTop
string [ 0 .. 255 ] characters
webAuthPasswordLabel
string [ 0 .. 32 ] characters

Responses

Request samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tag": "string",
  • "tenantId": "string",
  • "webAuthCustomBottom": "string",
  • "webAuthCustomLoginButton": "string",
  • "webAuthCustomTitle": "string",
  • "webAuthCustomTop": "string",
  • "webAuthPasswordLabel": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "switchCount": 0,
  • "switchVenueInfos": [
    ],
  • "tag": "string",
  • "venueCount": 0,
  • "webAuthCustomBottom": "string",
  • "webAuthCustomLoginButton": "string",
  • "webAuthCustomTitle": "string",
  • "webAuthCustomTop": "string",
  • "webAuthPageTemplateViewList": [
    ],
  • "webAuthPasswordLabel": "string",
  • "webAuthUserIdLabel": "string"
}

Get Web Authentication Template's Switch Info Deprecated

Get a web authentication page template's switch info by id.

path Parameters
templateId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "switchCount": 0,
  • "switchVenueInfos": [
    ],
  • "tag": "string",
  • "venueCount": 0,
  • "webAuthCustomBottom": "string",
  • "webAuthCustomLoginButton": "string",
  • "webAuthCustomTitle": "string",
  • "webAuthCustomTop": "string",
  • "webAuthPageTemplateViewList": [
    ],
  • "webAuthPasswordLabel": "string",
  • "webAuthUserIdLabel": "string"
}

Get Web Authentication Template's Switch Info

Get a web authentication page template's switch info by id.

path Parameters
templateId
required
string

Responses

Response samples

Content type
[
  • {
    }
]

Profile

Manage switch profiles.

Delete Switch Profiles Deprecated

Delete multiple regular switch profiles or command-line interface profiles.

Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Switch Profiles Deprecated

Get multiple regular switch profiles or command-line interface profiles.

Responses

Response samples

Content type
{
  • "acls": [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "profileType": "Regular",
  • "trustedPorts": [
    ],
  • "venueCliTemplate": {
    },
  • "venueCount": 0,
  • "venues": [
    ],
  • "vlans": [
    ],
  • "voiceVlanConfigs": [
    ]
}

Add Switch Profile

Add a regular switch profile or command-line interface profile. Use activity API with request id to get the status update.

Request Body schema:
required
Array of objects (Switch_Service_API_&_Model_Documentation_AclBo) unique
description
string
id
string
name
string^.{1,64}$
profileType
string
Enum: "Regular" "CLI"
Array of objects (Switch_Service_API_&_Model_Documentation_TrustedPortBo) unique
object (Switch_Service_API_&_Model_Documentation_AcxVenueCliTemplateBo)
venues
Array of strings
Array of objects (Switch_Service_API_&_Model_Documentation_VlanBo) unique
Array of objects (Switch_Service_API_&_Model_Documentation_VoiceVlanConfigBo) unique

Responses

Request samples

Content type
{
  • "acls": [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "profileType": "Regular",
  • "trustedPorts": [
    ],
  • "venueCliTemplate": {
    },
  • "venues": [
    ],
  • "vlans": [
    ],
  • "voiceVlanConfigs": [
    ]
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Query Switch Profiles

List the regular switch profiles or command-line interface profiles.

Request Body schema:
required
fields
Array of strings
filterType
string
object
page
integer <int32>
pageSize
integer <int32>
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "filterType": "string",
  • "filters": {
    },
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Switch Profile

Delete a regular switch profile or command-line interface profile.

path Parameters
switchProfileId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Switch Profile

Get a regular switch profile or command-line interface profile.

path Parameters
switchProfileId
required
string

Responses

Response samples

Content type
{
  • "acls": [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "profileType": "Regular",
  • "trustedPorts": [
    ],
  • "venueCliTemplate": {
    },
  • "venueCount": 0,
  • "venues": [
    ],
  • "vlans": [
    ],
  • "voiceVlanConfigs": [
    ]
}

Update Switch Profile

Update a regular switch profile or command-line interface profile. Use activity API with request id to get the status update.

path Parameters
switchProfileId
required
string
Request Body schema:
required
Array of objects (Switch_Service_API_&_Model_Documentation_AclBo) unique
description
string
id
string
name
string^.{1,64}$
profileType
string
Enum: "Regular" "CLI"
Array of objects (Switch_Service_API_&_Model_Documentation_TrustedPortBo) unique
object (Switch_Service_API_&_Model_Documentation_AcxVenueCliTemplateBo)
venues
Array of strings
Array of objects (Switch_Service_API_&_Model_Documentation_VlanBo) unique
Array of objects (Switch_Service_API_&_Model_Documentation_VoiceVlanConfigBo) unique

Responses

Request samples

Content type
{
  • "acls": [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "profileType": "Regular",
  • "trustedPorts": [
    ],
  • "venueCliTemplate": {
    },
  • "venues": [
    ],
  • "vlans": [
    ],
  • "voiceVlanConfigs": [
    ]
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Switch Profiles

Get regular switch profiles or command-line interface profiles of the venue.

path Parameters
venueId
required
string

Responses

Response samples

Content type
{
  • "acls": [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "profileType": "Regular",
  • "trustedPorts": [
    ],
  • "venueCliTemplate": {
    },
  • "venueCount": 0,
  • "venues": [
    ],
  • "vlans": [
    ],
  • "voiceVlanConfigs": [
    ]
}

Disassociate SwitchProfile to Venue

Disassociate SwitchProfile to Venue.

path Parameters
venueId
required
string
switchProfileId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Associate SwitchProfile to Venue

Associate SwitchProfile to Venue.

path Parameters
venueId
required
string
switchProfileId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Configuration History

Retrieve configuration history.

Get Configuration History Deprecated

Query for configuration history details on this switch.

path Parameters
switchId
required
string
Request Body schema:
required
filterByConfigType
string
filterByStatus
string
Enum: "ALL" "SUCCESS" "FAILED" "NOTIFY_SUCCESS"
object (Switch_Service_API_&_Model_Documentation_ConfigurationHistoryFilter)
limit
integer <int32>
orderBy
string
page
integer <int32>
pageSize
integer <int32>
sortField
string
Enum: "startTime" "configType" "dispatchStatus"
object (Switch_Service_API_&_Model_Documentation_ConfigurationHistoryDetailSortInfo)
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "filterByConfigType": "string",
  • "filterByStatus": "ALL",
  • "filters": {
    },
  • "limit": 0,
  • "orderBy": "string",
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "startTime",
  • "sortInfo": {
    },
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "id": "string",
  • "list": [
    ],
  • "totalCount": 0
}

Get Configuration History Deprecated

Get the configuration history details of this transaction on this switch.

path Parameters
switchId
required
string
transactionId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "list": [
    ],
  • "totalCount": 0
}

Get Configuration History

Query for configuration history details for switches in this venue.

path Parameters
venueId
required
string
Request Body schema:
required
filterByConfigType
string
object (Switch_Service_API_&_Model_Documentation_ConfigurationHistoryFilter)
limit
integer <int32>
page
integer <int32>
pageSize
integer <int32>
sortField
string
Value: "startTime"
object (Switch_Service_API_&_Model_Documentation_SortInfo)
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "filterByConfigType": "string",
  • "filters": {
    },
  • "limit": 0,
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "startTime",
  • "sortInfo": {
    },
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "id": "string",
  • "list": [
    ],
  • "totalCount": 0
}

Get Configuration History

Query for configuration history details on this switch.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
filterByConfigType
string
Enum: "PROVISIONING" "ACL" "VLAN" "STATIC_ROUTE" "PORT_CONFIGURATION" "CLI_PROVISIONING" "CLI_UPDATE" "VE_PORTS" "SPECIFIC_SETTING" "LAG" "DNS_SERVER" "AAA_SETTING" "AAA_SERVER" "MSP_CONFIGURATION" "SYSLOG_SERVER" "DHCP_SERVER" "TRUSTED_PORT" "STACK" "IP_CONFIG" "OVERWRITE" "DEFAULT_VLAN" "TRIGGER_SYNC" "COLLECT_CONFIG" "VXLAN" "WEB_AUTHENTICATION" "ADMIN_PASSWORD"
page
integer <int32>
pageSize
integer <int32>
sortField
string
Enum: "startTime" "configType" "dispatchStatus"
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "filterByConfigType": "PROVISIONING",
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "startTime",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "id": "string",
  • "list": [
    ],
  • "totalCount": 0
}

Get Configuration History

Get the configuration history details of this transaction on this switch.

path Parameters
venueId
required
string
switchId
required
string
transactionId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "list": [
    ],
  • "totalCount": 0
}

Get Configuration History

Get the configuration history details for this transaction relative to the switches in this venue.

path Parameters
venueId
required
string
transactionId
required
string
Request Body schema:
required
filterByConfigType
string
filterByStatus
string
Enum: "ALL" "SUCCESS" "FAILED" "NOTIFY_SUCCESS"
object (Switch_Service_API_&_Model_Documentation_ConfigurationHistoryFilter)
limit
integer <int32>
orderBy
string
page
integer <int32>
pageSize
integer <int32>
sortField
string
Enum: "startTime" "configType" "dispatchStatus"
object (Switch_Service_API_&_Model_Documentation_ConfigurationHistoryDetailSortInfo)
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "filterByConfigType": "string",
  • "filterByStatus": "ALL",
  • "filters": {
    },
  • "limit": 0,
  • "orderBy": "string",
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "startTime",
  • "sortInfo": {
    },
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "id": "string",
  • "list": [
    ],
  • "totalCount": 0
}

Switch Virtual Ethernet

Manage VE (virtual ethernet) port settings.

Delete Virtual Ethernet Settings Deprecated

Delete multiple virtual ethernet ports.

Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Virtual Ethernet Setting Deprecated

Delete virtual ethernet port.

path Parameters
vePortId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Virtual Ethernet Setting Deprecated

Get a specified virtual ethernet port.

path Parameters
vePortId
required
string

Responses

Response samples

Content type
{
  • "defaultVlan": true,
  • "dhcpRelayAgent": "string",
  • "egressAcl": "string",
  • "id": "string",
  • "ingressAcl": "string",
  • "ipAddress": "string",
  • "ipAddressType": "static",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "switchId": "string",
  • "veId": 0,
  • "vlanId": 0,
  • "vsixEgressAcl": "string",
  • "vsixIngressAcl": "string"
}

Update Virtual Ethernet Setting Deprecated

Update virtual ethernet port.

path Parameters
vePortId
required
string
Request Body schema:
required
defaultVlan
boolean
dhcpRelayAgent
string
egressAcl
string
id
string
ifIsDhcpVEDefaultCase
integer <int32>
ingressAcl
string
ipAddress
string
ipAddressType
string
Enum: "static" "dynamic"
ipSubnetMask
string
name
string
ospfArea
string
switchId
string
veId
integer <int32>
vlanId
integer <int32>
vsixEgressAcl
string
vsixIngressAcl
string

Responses

Request samples

Content type
{
  • "defaultVlan": true,
  • "dhcpRelayAgent": "string",
  • "egressAcl": "string",
  • "id": "string",
  • "ifIsDhcpVEDefaultCase": 0,
  • "ingressAcl": "string",
  • "ipAddress": "string",
  • "ipAddressType": "static",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "switchId": "string",
  • "veId": 0,
  • "vlanId": 0,
  • "vsixEgressAcl": "string",
  • "vsixIngressAcl": "string"
}

Response samples

Content type
{
  • "connectedVe": true,
  • "defaultVlan": true,
  • "deviceStatus": "string",
  • "dhcpRelayAgent": "string",
  • "egressAclName": "string",
  • "id": "string",
  • "ingressAclName": "string",
  • "ipAddress": "string",
  • "ipAddressType": "static",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "portType": "NONE",
  • "stack": true,
  • "switchId": "string",
  • "switchName": "string",
  • "syncedSwitchConfig": true,
  • "tenantId": "string",
  • "veId": 0,
  • "vePortViewList": [
    ],
  • "vlanId": 0,
  • "vsixEgressAclName": "string",
  • "vsixIngressAclName": "string"
}

Retrieve Virtual Ethernet Settings Deprecated

Retrieve virtual ethernet ports of the specified switch.

path Parameters
switchId
required
string

Responses

Response samples

Content type
{
  • "connectedVe": true,
  • "defaultVlan": true,
  • "deviceStatus": "string",
  • "dhcpRelayAgent": "string",
  • "egressAclName": "string",
  • "id": "string",
  • "ingressAclName": "string",
  • "ipAddress": "string",
  • "ipAddressType": "static",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "portType": "NONE",
  • "stack": true,
  • "switchId": "string",
  • "switchName": "string",
  • "syncedSwitchConfig": true,
  • "tenantId": "string",
  • "veId": 0,
  • "vePortViewList": [
    ],
  • "vlanId": 0,
  • "vsixEgressAclName": "string",
  • "vsixIngressAclName": "string"
}

Add Virtual Ethernet Settings Deprecated

Add virtual ethernet ports of the switch.

path Parameters
switchId
required
string
Request Body schema:
required
Array
defaultVlan
boolean
dhcpRelayAgent
string
egressAcl
string
id
string
ifIsDhcpVEDefaultCase
integer <int32>
ingressAcl
string
ipAddress
string
ipAddressType
string
Enum: "static" "dynamic"
ipSubnetMask
string
name
string
ospfArea
string
switchId
string
veId
integer <int32>
vlanId
integer <int32>
vsixEgressAcl
string
vsixIngressAcl
string

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "connectedVe": true,
  • "defaultVlan": true,
  • "deviceStatus": "string",
  • "dhcpRelayAgent": "string",
  • "egressAclName": "string",
  • "id": "string",
  • "ingressAclName": "string",
  • "ipAddress": "string",
  • "ipAddressType": "static",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "portType": "NONE",
  • "stack": true,
  • "switchId": "string",
  • "switchName": "string",
  • "syncedSwitchConfig": true,
  • "tenantId": "string",
  • "veId": 0,
  • "vePortViewList": [
    ],
  • "vlanId": 0,
  • "vsixEgressAclName": "string",
  • "vsixIngressAclName": "string"
}

Retrieve Virtual Ethernet Settings Deprecated

Retrieve virtual ethernet ports of switch by query.

path Parameters
switchId
required
string
Request Body schema:
required
fields
Array of strings
filterType
string
object
page
integer <int32>
pageSize
integer <int32>
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "filterType": "string",
  • "filters": {
    },
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Virtual Ethernet Settings

Delete multiple virtual ethernet ports.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Retrieve Virtual Ethernet Settings

Retrieve virtual ethernet ports of the specified switch.

path Parameters
venueId
required
string
switchId
required
string

Responses

Response samples

Content type
[
  • {
    }
]

Add Virtual Ethernet Settings

Add virtual ethernet ports of the switch.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
Array
dhcpRelayAgent
string
egressAcl
string
ingressAcl
string
ipAddress
string
ipAddressType
string
Enum: "static" "dynamic"
ipSubnetMask
string
name
string
ospfArea
string
veId
integer <int32>
vlanId
integer <int32>

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Retrieve Virtual Ethernet Settings

Retrieve virtual ethernet ports of switch by query.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
fields
Array of strings
filterType
string
object
page
integer <int32>
pageSize
integer <int32>
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "filterType": "string",
  • "filters": {
    },
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Virtual Ethernet Setting

Delete virtual ethernet port.

path Parameters
venueId
required
string
switchId
required
string
vePortId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Virtual Ethernet Setting

Get a specified virtual ethernet port.

path Parameters
venueId
required
string
switchId
required
string
vePortId
required
string

Responses

Response samples

Content type
{
  • "connectedVe": true,
  • "deviceStatus": "string",
  • "dhcpRelayAgent": "string",
  • "egressAclName": "string",
  • "id": "string",
  • "ingressAclName": "string",
  • "ipAddress": "string",
  • "ipAddressType": "static",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "switchId": "string",
  • "switchName": "string",
  • "syncedSwitchConfig": true,
  • "veId": 0,
  • "vlanId": 0,
  • "vsixEgressAclName": "string",
  • "vsixIngressAclName": "string"
}

Update Virtual Ethernet Setting

Update virtual ethernet port.

path Parameters
venueId
required
string
switchId
required
string
vePortId
required
string
Request Body schema:
required
dhcpRelayAgent
string
egressAcl
string
ingressAcl
string
ipAddress
string
ipAddressType
string
Enum: "static" "dynamic"
ipSubnetMask
string
name
string
ospfArea
string
veId
integer <int32>
vlanId
integer <int32>

Responses

Request samples

Content type
{
  • "dhcpRelayAgent": "string",
  • "egressAcl": "string",
  • "ingressAcl": "string",
  • "ipAddress": "string",
  • "ipAddressType": "static",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "veId": 0,
  • "vlanId": 0
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Retrieve Virtual Ethernet Settings

Retrieve virtual ethernet ports of venue by query.

path Parameters
venueId
required
string
Request Body schema:
required
fields
Array of strings
filterType
string
object
page
integer <int32>
pageSize
integer <int32>
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "filterType": "string",
  • "filters": {
    },
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Profile ACL

Manage ACL (access control list) of switch profile.

Delete ACLs Deprecated

Delete multiple ACLs of the switch profile.

path Parameters
switchProfileId
required
string
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get ACLs Deprecated

Get multiple ACLs of the switch profile.

path Parameters
switchProfileId
required
string
query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
{
  • "aclRules": [
    ],
  • "aclType": "standard",
  • "aclViewList": [
    ],
  • "id": "string",
  • "name": "string"
}

Add ACL Deprecated

Add the ACL of the switch profile.

path Parameters
switchProfileId
required
string
Request Body schema: application/json
required
Array of objects (Switch_Service_API_&_Model_Documentation_AclRuleBo) unique
aclType
string
Enum: "standard" "extended" "IPv6"
id
string
name
string
switchId
string
uniqueName
string

Responses

Request samples

Content type
application/json
{
  • "aclRules": [
    ],
  • "aclType": "standard",
  • "id": "string",
  • "name": "string",
  • "switchId": "string",
  • "uniqueName": "string"
}

Response samples

Content type
{
  • "aclRules": [
    ],
  • "aclType": "standard",
  • "aclViewList": [
    ],
  • "id": "string",
  • "name": "string"
}

Delete ACL Deprecated

Delete ACL of the switch profile.

path Parameters
switchProfileId
required
string
aclId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get ACL Deprecated

Get the ACL of the switch profile.

path Parameters
switchProfileId
required
string
aclId
required
string

Responses

Response samples

Content type
{
  • "aclRules": [
    ],
  • "aclType": "standard",
  • "aclViewList": [
    ],
  • "id": "string",
  • "name": "string"
}

Update ACL Deprecated

Update the ACL of the switch profile.

path Parameters
switchProfileId
required
string
aclId
required
string
Request Body schema: application/json
required
Array of objects (Switch_Service_API_&_Model_Documentation_AclRuleBo) unique
aclType
string
Enum: "standard" "extended" "IPv6"
id
string
name
string
switchId
string
uniqueName
string

Responses

Request samples

Content type
application/json
{
  • "aclRules": [
    ],
  • "aclType": "standard",
  • "id": "string",
  • "name": "string",
  • "switchId": "string",
  • "uniqueName": "string"
}

Response samples

Content type
{
  • "aclRules": [
    ],
  • "aclType": "standard",
  • "aclViewList": [
    ],
  • "id": "string",
  • "name": "string"
}

Get ACLs Deprecated

Get all ACLs of switch profiles in the venue.

path Parameters
venueId
required
string

Responses

Response samples

Content type
{
  • "aclRules": [
    ],
  • "aclType": "standard",
  • "aclViewList": [
    ],
  • "id": "string",
  • "name": "string"
}

Switch VLAN

Manage VLANs (virtual local area networks).

Delete Switch VLANs Deprecated

Delete multiple VLANs of the switch.

Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Add Switch VLANs Deprecated

Create multiple VLANs under the specified switches.

Request Body schema:
required
Array
arpInspection
boolean
arpInspectionTrustPort
string
arpInspectionTrustPortList
Array of strings
arpTrustPortsList
Array of strings
defaultVlan
boolean
dhcpTrustPortsList
Array of strings
dummyVlan
boolean
enableAsDefaultVlan
required
boolean
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
igmpSnoopingTypeChanged
boolean
ipv4DhcpSnooping
boolean
ipv4DhcpSnoopingTrustPort
string
ipv4DhcpSnoopingTrustPortList
Array of strings
managementVlan
boolean
multicastVersion
integer <int32> [ 0 .. 3 ]
notDummyVlan
boolean
rapidSpanningTreeProtocol
boolean
rootBridgeFamilyId
string
Enum: "__NULL" "ICX7150" "ICX7250" "ICX7650" "ICX7850" "ICX7550" "ICX8200" "ICX8100"
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
spanningTreeProtocol
string
Enum: "rstp" "stp" "none"
Array of objects (Switch_Service_API_&_Model_Documentation_SwitchFamilyModelBo) unique
switchId
string
object (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo)
Array of objects (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo) unique
taggedPortsList
Array of strings
untaggedPortsList
Array of strings
vlanId
required
integer <int32> [ 1 .. 4095 ]
vlanName
string

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Retrieve Switch VLANs Deprecated

Retrieve all usable VLANs under the specified switches.

Request Body schema:
required
isDefault
boolean
switchIds
Array of strings

Responses

Request samples

Content type
{
  • "isDefault": true,
  • "switchIds": [
    ]
}

Response samples

Content type
{
  • "defaultVlanId": 0,
  • "id": "string",
  • "switchId": "string",
  • "vlanList": [
    ]
}

Delete Switch VLAN Deprecated

Delete a VLAN of the switch.

path Parameters
vlanId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Switch VLAN Deprecated

Get the specified switch-level VLAN by id.

path Parameters
vlanId
required
string

Responses

Response samples

Content type
{
  • "arpInspection": true,
  • "enableAsDefaultVlan": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "multicastVersion": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchVlanPortModels": [
    ],
  • "taggedPorts": "string",
  • "untaggedPorts": "string",
  • "vePort": {
    },
  • "vlanId": 0,
  • "vlanName": "string"
}

Update Switch VLAN Deprecated

Update a VLAN of the switch.

path Parameters
vlanId
required
string
Request Body schema:
required
arpInspection
boolean
arpInspectionTrustPort
string
arpInspectionTrustPortList
Array of strings
arpTrustPortsList
Array of strings
defaultVlan
boolean
dhcpTrustPortsList
Array of strings
dummyVlan
boolean
enableAsDefaultVlan
required
boolean
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
igmpSnoopingTypeChanged
boolean
ipv4DhcpSnooping
boolean
ipv4DhcpSnoopingTrustPort
string
ipv4DhcpSnoopingTrustPortList
Array of strings
managementVlan
boolean
multicastVersion
integer <int32> [ 0 .. 3 ]
notDummyVlan
boolean
rapidSpanningTreeProtocol
boolean
rootBridgeFamilyId
string
Enum: "__NULL" "ICX7150" "ICX7250" "ICX7650" "ICX7850" "ICX7550" "ICX8200" "ICX8100"
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
spanningTreeProtocol
string
Enum: "rstp" "stp" "none"
Array of objects (Switch_Service_API_&_Model_Documentation_SwitchFamilyModelBo) unique
switchId
string
object (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo)
Array of objects (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo) unique
taggedPortsList
Array of strings
untaggedPortsList
Array of strings
vlanId
required
integer <int32> [ 1 .. 4095 ]
vlanName
string

Responses

Request samples

Content type
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "arpInspectionTrustPortList": [
    ],
  • "arpTrustPortsList": [
    ],
  • "defaultVlan": true,
  • "dhcpTrustPortsList": [
    ],
  • "dummyVlan": true,
  • "enableAsDefaultVlan": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "igmpSnoopingTypeChanged": true,
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "ipv4DhcpSnoopingTrustPortList": [
    ],
  • "managementVlan": true,
  • "multicastVersion": 3,
  • "notDummyVlan": true,
  • "rapidSpanningTreeProtocol": true,
  • "rootBridgeFamilyId": "__NULL",
  • "spanningTreePriority": 65535,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "switchId": "string",
  • "switchVlanPortModel": {
    },
  • "switchVlanPortModels": [
    ],
  • "taggedPortsList": [
    ],
  • "untaggedPortsList": [
    ],
  • "vlanId": 1,
  • "vlanName": "string"
}

Response samples

Content type
{
  • "arpInspection": true,
  • "enableAsDefaultVlan": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "multicastVersion": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchVlanPortModels": [
    ],
  • "taggedPorts": "string",
  • "untaggedPorts": "string",
  • "vePort": {
    },
  • "vlanId": 0,
  • "vlanName": "string"
}

Get Switch VLANs Deprecated

Get switch-level VLANs by switch.

path Parameters
switchId
required
string

Responses

Response samples

Content type
{
  • "arpInspection": true,
  • "enableAsDefaultVlan": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "multicastVersion": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchVlanPortModels": [
    ],
  • "taggedPorts": "string",
  • "untaggedPorts": "string",
  • "vePort": {
    },
  • "vlanId": 0,
  • "vlanName": "string"
}

Add Switch VLAN Deprecated

Create a VLAN of the switch.

path Parameters
switchId
required
string
Request Body schema:
required
arpInspection
boolean
arpInspectionTrustPort
string
arpInspectionTrustPortList
Array of strings
arpTrustPortsList
Array of strings
defaultVlan
boolean
dhcpTrustPortsList
Array of strings
dummyVlan
boolean
enableAsDefaultVlan
required
boolean
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
igmpSnoopingTypeChanged
boolean
ipv4DhcpSnooping
boolean
ipv4DhcpSnoopingTrustPort
string
ipv4DhcpSnoopingTrustPortList
Array of strings
managementVlan
boolean
multicastVersion
integer <int32> [ 0 .. 3 ]
notDummyVlan
boolean
rapidSpanningTreeProtocol
boolean
rootBridgeFamilyId
string
Enum: "__NULL" "ICX7150" "ICX7250" "ICX7650" "ICX7850" "ICX7550" "ICX8200" "ICX8100"
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
spanningTreeProtocol
string
Enum: "rstp" "stp" "none"
Array of objects (Switch_Service_API_&_Model_Documentation_SwitchFamilyModelBo) unique
switchId
string
object (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo)
Array of objects (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo) unique
taggedPortsList
Array of strings
untaggedPortsList
Array of strings
vlanId
required
integer <int32> [ 1 .. 4095 ]
vlanName
string

Responses

Request samples

Content type
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "arpInspectionTrustPortList": [
    ],
  • "arpTrustPortsList": [
    ],
  • "defaultVlan": true,
  • "dhcpTrustPortsList": [
    ],
  • "dummyVlan": true,
  • "enableAsDefaultVlan": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "igmpSnoopingTypeChanged": true,
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "ipv4DhcpSnoopingTrustPortList": [
    ],
  • "managementVlan": true,
  • "multicastVersion": 3,
  • "notDummyVlan": true,
  • "rapidSpanningTreeProtocol": true,
  • "rootBridgeFamilyId": "__NULL",
  • "spanningTreePriority": 65535,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "switchId": "string",
  • "switchVlanPortModel": {
    },
  • "switchVlanPortModels": [
    ],
  • "taggedPortsList": [
    ],
  • "untaggedPortsList": [
    ],
  • "vlanId": 1,
  • "vlanName": "string"
}

Response samples

Content type
{
  • "arpInspection": true,
  • "enableAsDefaultVlan": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "multicastVersion": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchVlanPortModels": [
    ],
  • "taggedPorts": "string",
  • "untaggedPorts": "string",
  • "vePort": {
    },
  • "vlanId": 0,
  • "vlanName": "string"
}

Query Switch VLANs Deprecated

Query the switch's switch-level VLANs.

path Parameters
switchId
required
string
Request Body schema:
required
fields
Array of strings
filterType
string
object
page
integer <int32>
pageSize
integer <int32>
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "filterType": "string",
  • "filters": {
    },
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Switch VLANs

Delete multiple VLANs of the switch.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get VLAN-VE-Ports

List all usable VLANs that are available for the VE setting.

path Parameters
venueId
required
string
switchId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "usedByVePort": true,
  • "vlanId": "string",
  • "vlanName": "string"
}

Add Switch VLAN

Create a VLAN of the switch.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
arpInspection
boolean
enableAsDefaultVlan
boolean
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
ipv4DhcpSnooping
boolean
multicastVersion
integer <int32> [ 0 .. 3 ]
spanningTreeProtocol
string
Enum: "rstp" "stp" "none"
Array of objects (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelViewV1001) unique
vlanId
integer <int32> [ 1 .. 4095 ]
vlanName
string

Responses

Request samples

Content type
{
  • "arpInspection": true,
  • "enableAsDefaultVlan": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "multicastVersion": 3,
  • "spanningTreeProtocol": "rstp",
  • "switchVlanPortModels": [
    ],
  • "vlanId": 1,
  • "vlanName": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Query Switch VLANs

Query the switch's switch-level VLANs.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
fields
Array of strings
filterType
string
object
page
integer <int32>
pageSize
integer <int32>
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "filterType": "string",
  • "filters": {
    },
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Switch VLAN

Delete a VLAN of the switch.

path Parameters
venueId
required
string
switchId
required
string
vlanId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Switch VLAN

Get the specified switch-level VLAN by id.

path Parameters
venueId
required
string
switchId
required
string
vlanId
required
string

Responses

Response samples

Content type
{
  • "arpInspection": true,
  • "enableAsDefaultVlan": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "multicastVersion": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchVlanPortModels": [
    ],
  • "taggedPorts": "string",
  • "untaggedPorts": "string",
  • "usedByVePort": true,
  • "vlanId": 0,
  • "vlanName": "string"
}

Update Switch VLAN

Update a VLAN of the switch.

path Parameters
venueId
required
string
switchId
required
string
vlanId
required
string
Request Body schema:
required
arpInspection
boolean
enableAsDefaultVlan
boolean
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
ipv4DhcpSnooping
boolean
multicastVersion
integer <int32> [ 0 .. 3 ]
spanningTreeProtocol
string
Enum: "rstp" "stp" "none"
Array of objects (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelViewV1001) unique
vlanId
integer <int32> [ 1 .. 4095 ]
vlanName
string

Responses

Request samples

Content type
{
  • "arpInspection": true,
  • "enableAsDefaultVlan": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "multicastVersion": 3,
  • "spanningTreeProtocol": "rstp",
  • "switchVlanPortModels": [
    ],
  • "vlanId": 1,
  • "vlanName": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get VLANs

List all usable VLANs under this venue.

path Parameters
venueId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "vlanConfigName": "string",
  • "vlanId": 1
}

Retrieve Switch VLANs

Retrieve all usable VLANs under the specified switches.

path Parameters
venueId
required
string
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
[
  • {
    }
]

DHCP Server

Manage ICX DHCP servers.

Query DHCP Servers Deprecated

List of venue's DHCP servers.

Request Body schema:
required
fields
Array of strings
page
integer <int32>
pageSize
integer <int32>
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
Enum: "ASC" "DESC"
venueId
string

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "ASC",
  • "venueId": "string"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Get DHCP Server-Setting Deprecated

Get switch's DHCP server setting.

path Parameters
dhcpServerId
required
string

Responses

Response samples

Content type
{
  • "defaultRouterIp": "string",
  • "dhcpOptions": [
    ],
  • "excludedEnd": "string",
  • "excludedStart": "string",
  • "id": "string",
  • "leaseDays": 0,
  • "leaseHrs": 0,
  • "leaseMins": 0,
  • "network": "string",
  • "poolName": "string",
  • "subnetAddress": "string",
  • "subnetMask": "string"
}

Update DHCP Server Deprecated

Change switch's DHCP server state. Use activity API with request id to get the status update.

path Parameters
switchId
required
string
Request Body schema:
required
state
boolean

Responses

Request samples

Content type
{
  • "state": true
}

Response samples

Content type
{
  • "defaultRouterIp": "string",
  • "dhcpOptions": [
    ],
  • "excludedEnd": "string",
  • "excludedStart": "string",
  • "id": "string",
  • "leaseDays": 0,
  • "leaseHrs": 0,
  • "leaseMins": 0,
  • "network": "string",
  • "poolName": "string",
  • "subnetAddress": "string",
  • "subnetMask": "string"
}

Delete DHCP Servers Deprecated

Delete switch's DHCP servers.

path Parameters
switchId
required
string
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Add DHCP Server Deprecated

Add switch's DHCP server settings. Use activity API with request id to get the status update.

path Parameters
switchId
required
string
Request Body schema:
required
defaultRouterIp
string
Array of objects (Switch_Service_API_&_Model_Documentation_DhcpOptionBo)
dhcpServerEnabled
boolean
excludedEnd
string
excludedStart
string
id
string
leaseDays
integer <int32>
leaseHrs
integer <int32>
leaseMins
integer <int32>
network
string
poolName
string
prefixLength
string
subnetAddress
string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...
subnetMask
string^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128...
switchId
string

Responses

Request samples

Content type
{
  • "defaultRouterIp": "string",
  • "dhcpOptions": [
    ],
  • "dhcpServerEnabled": true,
  • "excludedEnd": "string",
  • "excludedStart": "string",
  • "id": "string",
  • "leaseDays": 0,
  • "leaseHrs": 0,
  • "leaseMins": 0,
  • "network": "string",
  • "poolName": "string",
  • "prefixLength": "string",
  • "subnetAddress": "string",
  • "subnetMask": "string",
  • "switchId": "string"
}

Response samples

Content type
{
  • "defaultRouterIp": "string",
  • "dhcpOptions": [
    ],
  • "excludedEnd": "string",
  • "excludedStart": "string",
  • "id": "string",
  • "leaseDays": 0,
  • "leaseHrs": 0,
  • "leaseMins": 0,
  • "network": "string",
  • "poolName": "string",
  • "subnetAddress": "string",
  • "subnetMask": "string"
}

Update DHCP Server-Setting Deprecated

Update switch's DHCP server setting.

path Parameters
switchId
required
string
Request Body schema:
required
defaultRouterIp
string
Array of objects (Switch_Service_API_&_Model_Documentation_DhcpOptionBo)
dhcpServerEnabled
boolean
excludedEnd
string
excludedStart
string
id
string
leaseDays
integer <int32>
leaseHrs
integer <int32>
leaseMins
integer <int32>
network
string
poolName
string
prefixLength
string
subnetAddress
string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\...
subnetMask
string^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128...
switchId
string

Responses

Request samples

Content type
{
  • "defaultRouterIp": "string",
  • "dhcpOptions": [
    ],
  • "dhcpServerEnabled": true,
  • "excludedEnd": "string",
  • "excludedStart": "string",
  • "id": "string",
  • "leaseDays": 0,
  • "leaseHrs": 0,
  • "leaseMins": 0,
  • "network": "string",
  • "poolName": "string",
  • "prefixLength": "string",
  • "subnetAddress": "string",
  • "subnetMask": "string",
  • "switchId": "string"
}

Response samples

Content type
{
  • "defaultRouterIp": "string",
  • "dhcpOptions": [
    ],
  • "excludedEnd": "string",
  • "excludedStart": "string",
  • "id": "string",
  • "leaseDays": 0,
  • "leaseHrs": 0,
  • "leaseMins": 0,
  • "network": "string",
  • "poolName": "string",
  • "subnetAddress": "string",
  • "subnetMask": "string"
}

Query DHCP Servers Deprecated

List of ICX's DHCP servers.

path Parameters
switchId
required
string
Request Body schema:
required
fields
Array of strings
page
integer <int32>
pageSize
integer <int32>
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
Enum: "ASC" "DESC"
venueId
string

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "ASC",
  • "venueId": "string"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete DHCP Server-Setting Deprecated

Delete switch's DHCP server setting.

path Parameters
switchId
required
string
dhcpServerId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Change Switch DHCP Server State

Change switch's DHCP server state. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
state
boolean

Responses

Request samples

Content type
{
  • "state": true
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete DHCP Servers

Delete switch's DHCP servers.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Add DHCP Server

Add switch's DHCP server settings. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
defaultRouterIp
string
Array of objects (Switch_Service_API_&_Model_Documentation_DhcpOptionViewV1001)
excludedEnd
string
excludedStart
string
id
string
leaseDays
integer <int32>
leaseHrs
integer <int32>
leaseMins
integer <int32>
poolName
string
subnetAddress
string
subnetMask
string

Responses

Request samples

Content type
{
  • "defaultRouterIp": "string",
  • "dhcpOptions": [
    ],
  • "excludedEnd": "string",
  • "excludedStart": "string",
  • "id": "string",
  • "leaseDays": 0,
  • "leaseHrs": 0,
  • "leaseMins": 0,
  • "poolName": "string",
  • "subnetAddress": "string",
  • "subnetMask": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Query DHCP Servers

List of ICX's DHCP servers.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
fields
Array of strings
page
integer <int32>
pageSize
integer <int32>
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete DHCP Server-Setting

Delete switch's DHCP server setting.

path Parameters
venueId
required
string
switchId
required
string
dhcpServerId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get DHCP Server-Setting

Get switch's DHCP server setting.

path Parameters
venueId
required
string
switchId
required
string
dhcpServerId
required
string

Responses

Response samples

Content type
{
  • "defaultRouterIp": "string",
  • "dhcpOptions": [
    ],
  • "excludedEnd": "string",
  • "excludedStart": "string",
  • "id": "string",
  • "leaseDays": 0,
  • "leaseHrs": 0,
  • "leaseMins": 0,
  • "poolName": "string",
  • "subnetAddress": "string",
  • "subnetMask": "string"
}

Update DHCP Server-Setting

Update switch's DHCP server setting.

path Parameters
venueId
required
string
switchId
required
string
dhcpServerId
required
string
Request Body schema:
required
defaultRouterIp
string
Array of objects (Switch_Service_API_&_Model_Documentation_DhcpOptionViewV1001)
excludedEnd
string
excludedStart
string
id
string
leaseDays
integer <int32>
leaseHrs
integer <int32>
leaseMins
integer <int32>
poolName
string
subnetAddress
string
subnetMask
string

Responses

Request samples

Content type
{
  • "defaultRouterIp": "string",
  • "dhcpOptions": [
    ],
  • "excludedEnd": "string",
  • "excludedStart": "string",
  • "id": "string",
  • "leaseDays": 0,
  • "leaseHrs": 0,
  • "leaseMins": 0,
  • "poolName": "string",
  • "subnetAddress": "string",
  • "subnetMask": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

AAA Server

Manage AAA (authentication, authorization, and accounting) Servers.

Delete AAA Servers Deprecated

Delete multiple authentication, authorization, and accounting servers.

Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Query AAA Servers Deprecated

List of venue's authentication, authorization, and accounting servers.

Request Body schema:
required
fields
Array of strings
page
integer <int32>
pageSize
integer <int32>
searchString
string
searchTargetFields
Array of strings
serverType
string
Enum: "__NULL" "RADIUS" "TACACS_PLUS" "LOCAL" "NONE_TYPE"
sortField
string
sortOrder
string
Enum: "ASC" "DESC"
venueId
string

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "serverType": "__NULL",
  • "sortField": "string",
  • "sortOrder": "ASC",
  • "venueId": "string"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete AAA Server Deprecated

Delete authentication, authorization, and accounting server by id.

path Parameters
aaaServerId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get AAA Server-Setting Deprecated

Get a switch's authentication, authorization, and accounting server setting.

path Parameters
aaaServerId
required
string

Responses

Response samples

Content type
{
  • "aaaServerViewList": [
    ],
  • "acctPort": 0,
  • "authPort": 0,
  • "id": "string",
  • "ip": "string",
  • "level": "UNSPECIFIED",
  • "name": "string",
  • "password": "string",
  • "purpose": "UNSPECIFIED",
  • "secret": "string",
  • "serverType": "__NULL",
  • "switchCountInVenue": 0,
  • "syncedPasswordSwitchCount": 0,
  • "username": "string"
}

Delete AAA Servers

Delete multiple authentication, authorization, and accounting servers.

path Parameters
venueId
required
string
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Add AAA Server

Add authentication, authorization, and accounting server. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
Request Body schema:
required
acctPort
integer <int32> [ 0 .. 65535 ]
authPort
integer <int32> [ 0 .. 65535 ]
encryptedPassword
string
id
string
ip
string^([1-9]|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])(\.([0...
level
string
Enum: "UNSPECIFIED" "READ_WRITE" "PORT_CONFIG" "READ_ONLY" "LEVEL_NONE"
name
string [ 2 .. 64 ] characters
password
string [ 8 .. 64 ] characters
purpose
string
Enum: "UNSPECIFIED" "DEFAULT" "AUTHENTICATION_ONLY" "AUTHORIZATION_ONLY" "ACCOUNTING_ONLY"
secret
string [ 1 .. 64 ] characters
serverType
string
Enum: "__NULL" "RADIUS" "TACACS_PLUS" "LOCAL" "NONE_TYPE"
username
string [ 2 .. 48 ] characters

Responses

Request samples

Content type
{
  • "acctPort": 65535,
  • "authPort": 65535,
  • "encryptedPassword": "string",
  • "id": "string",
  • "ip": "string",
  • "level": "UNSPECIFIED",
  • "name": "string",
  • "password": "stringst",
  • "purpose": "UNSPECIFIED",
  • "secret": "string",
  • "serverType": "__NULL",
  • "username": "string"
}

Response samples

Content type
{
  • "aaaServerViewList": [
    ],
  • "acctPort": 0,
  • "authPort": 0,
  • "id": "string",
  • "ip": "string",
  • "level": "UNSPECIFIED",
  • "name": "string",
  • "password": "string",
  • "purpose": "UNSPECIFIED",
  • "secret": "string",
  • "serverType": "__NULL",
  • "switchCountInVenue": 0,
  • "syncedPasswordSwitchCount": 0,
  • "username": "string"
}

Query AAA Servers

List of venue's authentication, authorization, and accounting servers.

path Parameters
venueId
required
string
Request Body schema:
required
fields
Array of strings
page
integer <int32>
pageSize
integer <int32>
searchString
string
searchTargetFields
Array of strings
serverType
string
Enum: "__NULL" "RADIUS" "TACACS_PLUS" "LOCAL" "NONE_TYPE"
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "serverType": "__NULL",
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete AAA Server

Delete authentication, authorization, and accounting server by id.

path Parameters
venueId
required
string
aaaServerId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get AAA Server-Setting

Get a switch's authentication, authorization, and accounting server setting.

path Parameters
venueId
required
string
aaaServerId
required
string

Responses

Response samples

Content type
{
  • "acctPort": 0,
  • "authPort": 0,
  • "id": "string",
  • "ip": "string",
  • "level": "UNSPECIFIED",
  • "name": "string",
  • "password": "string",
  • "purpose": "UNSPECIFIED",
  • "secret": "string",
  • "serverType": "__NULL",
  • "switchCountInVenue": 0,
  • "syncedPasswordSwitchCount": 0,
  • "username": "string"
}

Update AAA Server

Update authentication, authorization, and accounting server by id. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
aaaServerId
required
string
Request Body schema:
required
acctPort
integer <int32> [ 0 .. 65535 ]
authPort
integer <int32> [ 0 .. 65535 ]
encryptedPassword
string
id
string
ip
string^([1-9]|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])(\.([0...
level
string
Enum: "UNSPECIFIED" "READ_WRITE" "PORT_CONFIG" "READ_ONLY" "LEVEL_NONE"
name
string [ 2 .. 64 ] characters
password
string [ 8 .. 64 ] characters
purpose
string
Enum: "UNSPECIFIED" "DEFAULT" "AUTHENTICATION_ONLY" "AUTHORIZATION_ONLY" "ACCOUNTING_ONLY"
secret
string [ 1 .. 64 ] characters
serverType
string
Enum: "__NULL" "RADIUS" "TACACS_PLUS" "LOCAL" "NONE_TYPE"
username
string [ 2 .. 48 ] characters

Responses

Request samples

Content type
{
  • "acctPort": 65535,
  • "authPort": 65535,
  • "encryptedPassword": "string",
  • "id": "string",
  • "ip": "string",
  • "level": "UNSPECIFIED",
  • "name": "string",
  • "password": "stringst",
  • "purpose": "UNSPECIFIED",
  • "secret": "string",
  • "serverType": "__NULL",
  • "username": "string"
}

Response samples

Content type
{
  • "aaaServerViewList": [
    ],
  • "acctPort": 0,
  • "authPort": 0,
  • "id": "string",
  • "ip": "string",
  • "level": "UNSPECIFIED",
  • "name": "string",
  • "password": "string",
  • "purpose": "UNSPECIFIED",
  • "secret": "string",
  • "serverType": "__NULL",
  • "switchCountInVenue": 0,
  • "syncedPasswordSwitchCount": 0,
  • "username": "string"
}

LAG

Manage LAGs (link aggregation groups).

Delete LAGs Deprecated

Delete switch's multiple LAG settings.

Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete LAG Deprecated

Delete switch's LAG setting.

path Parameters
lagId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get LAG Deprecated

Get LAG setting by id.

path Parameters
lagId
required
string

Responses

Response samples

Content type
{
  • "addPorts": [
    ],
  • "defaultVlanId": "string",
  • "id": "string",
  • "lagId": 0,
  • "lagViewList": [
    ],
  • "lastName": "string",
  • "name": "string",
  • "originalUntaggedVlan": "string",
  • "portAddVlans": [
    ],
  • "portVlans": [
    ],
  • "ports": [
    ],
  • "realRemove": true,
  • "removePorts": [
    ],
  • "switchId": "string",
  • "taggedVlans": [
    ],
  • "tenantId": "string",
  • "type": "static",
  • "untaggedVlan": "string"
}

Update LAG Deprecated

Update switch's LAG setting.

path Parameters
lagId
required
string
Request Body schema:
required
addPorts
Array of strings
defaultVlanId
string
id
string
lagId
integer <int32>
lastName
string
name
string^(?:(?!").){1,64}$
originalUntaggedVlan
string
Array of objects (Switch_Service_API_&_Model_Documentation_LagPortVlanBo)
Array of objects (Switch_Service_API_&_Model_Documentation_LagPortVlanBo)
ports
Array of strings unique
removePorts
Array of strings
switchId
string
taggedVlans
Array of strings unique
type
string
Enum: "static" "dynamic"
untaggedVlan
string

Responses

Request samples

Content type
{
  • "addPorts": [
    ],
  • "defaultVlanId": "string",
  • "id": "string",
  • "lagId": 0,
  • "lastName": "string",
  • "name": "string",
  • "originalUntaggedVlan": "string",
  • "portAddVlans": [
    ],
  • "portVlans": [
    ],
  • "ports": [
    ],
  • "removePorts": [
    ],
  • "switchId": "string",
  • "taggedVlans": [
    ],
  • "type": "static",
  • "untaggedVlan": "string"
}

Response samples

Content type
{
  • "addPorts": [
    ],
  • "defaultVlanId": "string",
  • "id": "string",
  • "lagId": 0,
  • "lagViewList": [
    ],
  • "lastName": "string",
  • "name": "string",
  • "originalUntaggedVlan": "string",
  • "portAddVlans": [
    ],
  • "portVlans": [
    ],
  • "ports": [
    ],
  • "realRemove": true,
  • "removePorts": [
    ],
  • "switchId": "string",
  • "taggedVlans": [
    ],
  • "tenantId": "string",
  • "type": "static",
  • "untaggedVlan": "string"
}

Get LAGs Deprecated

List of switch's LAG settings.

path Parameters
switchId
required
string

Responses

Response samples

Content type
{
  • "addPorts": [
    ],
  • "defaultVlanId": "string",
  • "id": "string",
  • "lagId": 0,
  • "lagViewList": [
    ],
  • "lastName": "string",
  • "name": "string",
  • "originalUntaggedVlan": "string",
  • "portAddVlans": [
    ],
  • "portVlans": [
    ],
  • "ports": [
    ],
  • "realRemove": true,
  • "removePorts": [
    ],
  • "switchId": "string",
  • "taggedVlans": [
    ],
  • "tenantId": "string",
  • "type": "static",
  • "untaggedVlan": "string"
}

Add LAGs Deprecated

Add switch's multiple LAG settings.

path Parameters
switchId
required
string
Request Body schema:
required
Array
addPorts
Array of strings
defaultVlanId
string
id
string
lagId
integer <int32>
lastName
string
name
string^(?:(?!").){1,64}$
originalUntaggedVlan
string
Array of objects (Switch_Service_API_&_Model_Documentation_LagPortVlanBo)
Array of objects (Switch_Service_API_&_Model_Documentation_LagPortVlanBo)
ports
Array of strings unique
removePorts
Array of strings
switchId
string
taggedVlans
Array of strings unique
type
string
Enum: "static" "dynamic"
untaggedVlan
string

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "addPorts": [
    ],
  • "defaultVlanId": "string",
  • "id": "string",
  • "lagId": 0,
  • "lagViewList": [
    ],
  • "lastName": "string",
  • "name": "string",
  • "originalUntaggedVlan": "string",
  • "portAddVlans": [
    ],
  • "portVlans": [
    ],
  • "ports": [
    ],
  • "realRemove": true,
  • "removePorts": [
    ],
  • "switchId": "string",
  • "taggedVlans": [
    ],
  • "tenantId": "string",
  • "type": "static",
  • "untaggedVlan": "string"
}

Delete LAGs

Delete switch's multiple LAG settings.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get LAGs

List of switch's LAG settings.

path Parameters
switchId
required
string
venueId
required
string

Responses

Response samples

Content type
[
  • {
    }
]

Add LAGs

Add switch's multiple LAG settings.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
Array
name
string
ports
Array of strings unique
taggedVlans
Array of strings unique
type
string
Enum: "static" "dynamic"
untaggedVlan
string

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete LAG

Delete switch's LAG setting.

path Parameters
venueId
required
string
switchId
required
string
lagId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get LAG

Get LAG setting by id.

path Parameters
venueId
required
string
switchId
required
string
lagId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "lagId": 0,
  • "name": "string",
  • "ports": [
    ],
  • "taggedVlans": [
    ],
  • "type": "static",
  • "untaggedVlan": "string"
}

Update LAG

Update switch's LAG setting.

path Parameters
venueId
required
string
switchId
required
string
lagId
required
string
Request Body schema:
required
name
string
ports
Array of strings unique
taggedVlans
Array of strings unique
type
string
Enum: "static" "dynamic"
untaggedVlan
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "ports": [
    ],
  • "taggedVlans": [
    ],
  • "type": "static",
  • "untaggedVlan": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Switch Firmware Upgrade

Manage firmware upgrade.

Get Current Versions

Get current versions of the venues.

Responses

Response samples

Content type
{
  • "currentVersions": [
    ],
  • "currentVersionsAboveTen": [
    ],
  • "id": "string"
}

Get Venues

Get all venues by tenant id for upgrading.

Request Body schema:
required
firmwareVersion
string
searchFilter
string

Responses

Request samples

Content type
{
  • "firmwareVersion": "string",
  • "searchFilter": "string"
}

Response samples

Content type
[
  • {
    }
]

Get Versions

Get different version type of firmware.

path Parameters
versionType
required
string

Responses

Response samples

Content type
[
  • {
    }
]

Get Current Versions Deprecated

Get current versions of the venues.

Responses

Response samples

Content type
{
  • "currentVersions": [
    ],
  • "currentVersionsAboveTen": [
    ],
  • "id": "string"
}

Delete Upgrade Schedule Deprecated

Cancel the schedule for firmware upgrade.

Request Body schema:
required
id
string
switchIds
Array of strings
venueIds
Array of strings

Responses

Request samples

Content type
{
  • "id": "string",
  • "switchIds": [
    ],
  • "venueIds": [
    ]
}

Response samples

Content type
{
  • "response": "string"
}

Create Upgrade Schedule Deprecated

Schedule the firmware upgrade for venues. Use activity API with request id to get the status update.

Request Body schema:
required
date
string
id
string
preDownload
boolean
switchIds
Array of strings
switchVersion
string
switchVersionAboveTen
string
time
string
venueIds
Array of strings

Responses

Request samples

Content type
{
  • "date": "string",
  • "id": "string",
  • "preDownload": true,
  • "switchIds": [
    ],
  • "switchVersion": "string",
  • "switchVersionAboveTen": "string",
  • "time": "string",
  • "venueIds": [
    ]
}

Response samples

Content type
{
  • "response": "string"
}

Get Venues Deprecated

Get all venues by tenant id for upgrading.

Request Body schema:
required
firmwareType
string
firmwareVersion
string
search
string
updateAvailable
boolean

Responses

Request samples

Content type
{
  • "firmwareType": "string",
  • "firmwareVersion": "string",
  • "search": "string",
  • "updateAvailable": true
}

Response samples

Content type
{
  • "aboveTenSwitchCount": 0,
  • "availableVersions": [
    ],
  • "id": "string",
  • "lastScheduleUpdateTime": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "nextSchedule": {
    },
  • "preDownload": true,
  • "scheduleCount": 0,
  • "status": "NONE",
  • "switchCount": 0,
  • "switchFirmwareVersion": {
    },
  • "switchFirmwareVersionAboveTen": {
    },
  • "upgradeVenueViewList": [
    ]
}

Get Switches Deprecated

Get all switches by tenant id for upgrading.

Request Body schema:
required
search
string
venueIdList
Array of strings

Responses

Request samples

Content type
{
  • "search": "string",
  • "venueIdList": [
    ]
}

Response samples

Content type
{
  • "availableVersion": {
    },
  • "currentFirmware": "string",
  • "id": "string",
  • "isStack": true,
  • "isSwitchLevelSchedule": true,
  • "model": "string",
  • "preDownload": true,
  • "switchId": "string",
  • "switchName": "string",
  • "switchNextSchedule": {
    },
  • "upgradeSwitchViewList": [
    ],
  • "venueId": "string",
  • "venueName": "string",
  • "venueNextSchedule": {
    }
}

Get Venue Upgrade Statuses Deprecated

Get venue upgrade status by venue id for upgrading.

Request Body schema:
required
venueId
string

Responses

Request samples

Content type
{
  • "venueId": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "lastStatusUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "switchId": "string",
  • "switchName": "string",
  • "switchStatus": "ONLINE",
  • "targetFirmware": "string",
  • "upgradeStatusDetailsViewList": [
    ]
}

Get Versions Deprecated

Get different version type of firmware.

path Parameters
versionType
required
string

Responses

Response samples

Content type
{
  • "category": "RECOMMENDED",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "name": "string"
}

Delete Upgrade Schedule

Cancel the schedule for firmware upgrade.

path Parameters
venueId
required
string
Request Body schema:
required
id
string
switchIds
Array of strings

Responses

Request samples

Content type
{
  • "id": "string",
  • "switchIds": [
    ]
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Create Upgrade Schedule

Schedule the firmware upgrade for venues. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
Request Body schema:
required
date
string
id
string
preDownload
boolean
switchIds
Array of strings
switchVersion
string
switchVersionAboveTen
string
time
string

Responses

Request samples

Content type
{
  • "date": "string",
  • "id": "string",
  • "preDownload": true,
  • "switchIds": [
    ],
  • "switchVersion": "string",
  • "switchVersionAboveTen": "string",
  • "time": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Switches

Get all switches by tenant id for upgrading.

path Parameters
venueId
required
string
Request Body schema:
required
searchFilter
string

Responses

Request samples

Content type
{
  • "searchFilter": "string"
}

Response samples

Content type
[
  • {
    }
]

Get Venue Upgrade Statuses

Get venue upgrade status by venue id for upgrading.

path Parameters
venueId
required
string

Responses

Response samples

Content type
[
  • {
    }
]

Import Switch

Import Switches.

Add Switches Deprecated

Add switches by CSV file. Use activity API with request id to get the status update.

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

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Add Switches

Add switches by CSV file. Use activity API with request id to get the status update.

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

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Switch Configuration Backup

Manage configuration backups.

Delete Switch Configuration Backups Deprecated

Delete switch's configuration backups.

Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Compare Switch Configuration Backups Deprecated

Compare switch's configuration backups.

Request Body schema:
required
backupId1
string
backupId2
string

Responses

Request samples

Content type
{
  • "backupId1": "string",
  • "backupId2": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "response": {
    }
}

Delete Switch Configuration Backup Deprecated

Delete switch's configuration backup by id.

path Parameters
configBackupId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Switch Configuration Backup Deprecated

Get a switch's configuration backup.

path Parameters
configBackupId
required
string

Responses

Response samples

Content type
{
  • "backupId": "string",
  • "backupName": "string",
  • "backupType": "string",
  • "config": "string",
  • "configBackupViewList": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "failureReason": "string",
  • "id": "string",
  • "name": "string",
  • "restoreStatus": "string",
  • "restoreTimestamp": "string",
  • "status": "string",
  • "switchId": "string"
}

Restore Switch Configuration Backup Deprecated

Restore switch's configuration backup.

path Parameters
configBackupId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Switch Configuration Backups Deprecated

List of switch's configuration backup.

path Parameters
switchId
required
string

Responses

Response samples

Content type
{
  • "backupId": "string",
  • "backupName": "string",
  • "backupType": "string",
  • "config": "string",
  • "configBackupViewList": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "failureReason": "string",
  • "id": "string",
  • "name": "string",
  • "restoreStatus": "string",
  • "restoreTimestamp": "string",
  • "status": "string",
  • "switchId": "string"
}

Add Switch Configuration Backup Deprecated

Create a switch's configuration backup.

path Parameters
switchId
required
string
Request Body schema:
required
name
string^(?:(?!").){1,64}$

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Retrieve Switch Configuration Backups Deprecated

Query the switch's configuration backups.

path Parameters
switchId
required
string
Request Body schema:
required
fields
Array of strings
filterType
string
object
page
integer <int32>
pageSize
integer <int32>
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "filterType": "string",
  • "filters": {
    },
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Switch Configuration Backups

Delete switch's configuration backups.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Switch Configuration Backups

List of switch's configuration backup.

path Parameters
venueId
required
string
switchId
required
string

Responses

Response samples

Content type
[
  • {
    }
]

Add Switch Configuration Backup

Create a switch's configuration backup.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
name
string^(?:(?!").){1,64}$

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Compare Switch Configuration Backups

Compare switch's configuration backups.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
backupId1
string
backupId2
string

Responses

Request samples

Content type
{
  • "backupId1": "string",
  • "backupId2": "string"
}

Response samples

Content type
{
  • "configBackup1": {
    },
  • "configBackup2": {
    },
  • "id": "string"
}

Retrieve Switch Configuration Backups

Query the switch's configuration backups.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
fields
Array of strings
filterType
string
object
page
integer <int32>
pageSize
integer <int32>
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "filterType": "string",
  • "filters": {
    },
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Switch Configuration Backup

Delete switch's configuration backup by id.

path Parameters
venueId
required
string
switchId
required
string
configBackupId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Switch Configuration Backup

Get a switch's configuration backup.

path Parameters
venueId
required
string
switchId
required
string
configBackupId
required
string

Responses

Response samples

Content type
{
  • "backupId": "string",
  • "backupType": "string",
  • "config": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "failureReason": "string",
  • "id": "string",
  • "name": "string",
  • "restoreStatus": "string",
  • "restoreTimestamp": "string",
  • "status": "string",
  • "switchId": "string"
}

Restore Switch Configuration Backup

Restore switch's configuration backup.

path Parameters
venueId
required
string
switchId
required
string
configBackupId
required
string
Request Body schema:
required
configBackupAction
string
Enum: "restore" "download"

Responses

Request samples

Content type
{
  • "configBackupAction": "restore"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Trusted Port

Manage a port's trust settings.

Delete Trusted Ports Deprecated

Delete multiple trusted ports of the specified switch profile.

path Parameters
switchProfileId
required
string
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Add Trusted Port Deprecated

Add the trusted port of the switch profile.

path Parameters
switchProfileId
required
string
Request Body schema:
required
id
string
model
string
Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" "ICX8200-24" "ICX8200-24P" "ICX8200-24F" "ICX8200-24FX" "ICX8200-24ZP" "ICX8200-48" "ICX8200-48F" "ICX8200-48P" "ICX8200-48PF" "ICX8200-48PF2" "ICX8200-48ZP2" "ICX8200-C08P" "ICX8200-C08PDC" "ICX8200-C08PF" "ICX8200-C08PT" "ICX8200-C08ZP" "ICX8100-24" "ICX8100-24P" "ICX8100-48" "ICX8100-48P" "ICX8100-C08PF"
object (Switch_Service_API_&_Model_Documentation_Profile)
Array of objects (Switch_Service_API_&_Model_Documentation_FamilyModelSlotBo) unique
tenantId
string
trustPorts
Array of strings
trustedPortType
string
Enum: "all" "dhcp" "arp"
vlanDemand
boolean

Responses

Request samples

Content type
{
  • "id": "string",
  • "model": "ICX7150-24",
  • "profile": {
    },
  • "slots": [
    ],
  • "tenantId": "string",
  • "trustPorts": [
    ],
  • "trustedPortType": "all",
  • "vlanDemand": true
}

Response samples

Content type
{
  • "id": "string",
  • "model": "ICX7150-24",
  • "slots": [
    ],
  • "trustPorts": [
    ],
  • "trustedPortType": "all",
  • "vlanDemand": true
}

Delete Trusted Port Deprecated

Delete the specified trusted port of the switch profile.

path Parameters
switchProfileId
required
string
trustedPortId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Trusted Port Deprecated

Get the specified trusted port of the switch profile.

path Parameters
switchProfileId
required
string
trustedPortId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "model": "ICX7150-24",
  • "slots": [
    ],
  • "trustPorts": [
    ],
  • "trustedPortType": "all",
  • "vlanDemand": true
}

Update Trusted Port Deprecated

Update the trusted port of the switch profile.

path Parameters
switchProfileId
required
string
trustedPortId
required
string
Request Body schema:
required
id
string
model
string
Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" "ICX8200-24" "ICX8200-24P" "ICX8200-24F" "ICX8200-24FX" "ICX8200-24ZP" "ICX8200-48" "ICX8200-48F" "ICX8200-48P" "ICX8200-48PF" "ICX8200-48PF2" "ICX8200-48ZP2" "ICX8200-C08P" "ICX8200-C08PDC" "ICX8200-C08PF" "ICX8200-C08PT" "ICX8200-C08ZP" "ICX8100-24" "ICX8100-24P" "ICX8100-48" "ICX8100-48P" "ICX8100-C08PF"
object (Switch_Service_API_&_Model_Documentation_Profile)
Array of objects (Switch_Service_API_&_Model_Documentation_FamilyModelSlotBo) unique
tenantId
string
trustPorts
Array of strings
trustedPortType
string
Enum: "all" "dhcp" "arp"
vlanDemand
boolean

Responses

Request samples

Content type
{
  • "id": "string",
  • "model": "ICX7150-24",
  • "profile": {
    },
  • "slots": [
    ],
  • "tenantId": "string",
  • "trustPorts": [
    ],
  • "trustedPortType": "all",
  • "vlanDemand": true
}

Response samples

Content type
{
  • "id": "string",
  • "model": "ICX7150-24",
  • "slots": [
    ],
  • "trustPorts": [
    ],
  • "trustedPortType": "all",
  • "vlanDemand": true
}

Get Trusted Ports Deprecated

Retrieve trusted ports with the specified venue.

path Parameters
venueId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "model": "ICX7150-24",
  • "slots": [
    ],
  • "trustPorts": [
    ],
  • "trustedPortType": "all",
  • "vlanDemand": true
}

Switch Ports

Manage Ports.

Get Ports Deprecated

Get port settings of different switches.

Request Body schema:
required
Array
ports
Array of strings
switchId
string

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "arpInspectionTrust": true,
  • "dhcpSnoopingTrust": true,
  • "egressAcl": "string",
  • "id": "string",
  • "ignoreFields": "string",
  • "ingressAcl": "string",
  • "ipsg": true,
  • "lag": {
    },
  • "lldpEnable": true,
  • "lldpQos": [
    ],
  • "name": "string",
  • "poeBudget": 0.1,
  • "poeCapability": true,
  • "poeClass": "__NULL",
  • "poeEnable": true,
  • "poePriority": 0,
  • "port": "string",
  • "portEnable": true,
  • "portProtected": true,
  • "portSpeed": "__NULL",
  • "ports": [
    ],
  • "profileName": "string",
  • "revert": true,
  • "rstpAdminEdgePort": true,
  • "stpBpduGuard": true,
  • "stpRootGuard": true,
  • "switchId": "string",
  • "switchMac": "string",
  • "taggedVlans": [
    ],
  • "tags": "string",
  • "untaggedVlan": "string",
  • "voiceVlan": 0,
  • "vsixEgressAcl": "string",
  • "vsixIngressAcl": "string"
}

Update Ports Deprecated

Update ports of different switches. Use activity API with request id to get the status update.

Request Body schema:
required
Array
object (Switch_Service_API_&_Model_Documentation_UpdatePortBo)
switchId
string

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "arpInspectionTrust": true,
  • "dhcpSnoopingTrust": true,
  • "egressAcl": "string",
  • "id": "string",
  • "ignoreFields": "string",
  • "ingressAcl": "string",
  • "ipsg": true,
  • "lag": {
    },
  • "lldpEnable": true,
  • "lldpQos": [
    ],
  • "name": "string",
  • "poeBudget": 0.1,
  • "poeCapability": true,
  • "poeClass": "__NULL",
  • "poeEnable": true,
  • "poePriority": 0,
  • "port": "string",
  • "portEnable": true,
  • "portProtected": true,
  • "portSpeed": "__NULL",
  • "ports": [
    ],
  • "profileName": "string",
  • "revert": true,
  • "rstpAdminEdgePort": true,
  • "stpBpduGuard": true,
  • "stpRootGuard": true,
  • "switchId": "string",
  • "switchMac": "string",
  • "taggedVlans": [
    ],
  • "tags": "string",
  • "untaggedVlan": "string",
  • "voiceVlan": 0,
  • "vsixEgressAcl": "string",
  • "vsixIngressAcl": "string"
}

Get Ports Deprecated

Get switch's port settings by switch id.

path Parameters
switchId
required
string

Responses

Response samples

Content type
{
  • "arpInspectionTrust": true,
  • "dhcpSnoopingTrust": true,
  • "egressAcl": "string",
  • "id": "string",
  • "ignoreFields": "string",
  • "ingressAcl": "string",
  • "ipsg": true,
  • "lag": {
    },
  • "lldpEnable": true,
  • "lldpQos": [
    ],
  • "name": "string",
  • "poeBudget": 0.1,
  • "poeCapability": true,
  • "poeClass": "__NULL",
  • "poeEnable": true,
  • "poePriority": 0,
  • "port": "string",
  • "portEnable": true,
  • "portProtected": true,
  • "portSpeed": "__NULL",
  • "ports": [
    ],
  • "profileName": "string",
  • "revert": true,
  • "rstpAdminEdgePort": true,
  • "stpBpduGuard": true,
  • "stpRootGuard": true,
  • "switchId": "string",
  • "switchMac": "string",
  • "taggedVlans": [
    ],
  • "tags": "string",
  • "untaggedVlan": "string",
  • "voiceVlan": 0,
  • "vsixEgressAcl": "string",
  • "vsixIngressAcl": "string"
}

Get Ports Deprecated

Get switch's port settings with port ids.

path Parameters
switchId
required
string
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "arpInspectionTrust": true,
  • "dhcpSnoopingTrust": true,
  • "egressAcl": "string",
  • "id": "string",
  • "ignoreFields": "string",
  • "ingressAcl": "string",
  • "ipsg": true,
  • "lag": {
    },
  • "lldpEnable": true,
  • "lldpQos": [
    ],
  • "name": "string",
  • "poeBudget": 0.1,
  • "poeCapability": true,
  • "poeClass": "__NULL",
  • "poeEnable": true,
  • "poePriority": 0,
  • "port": "string",
  • "portEnable": true,
  • "portProtected": true,
  • "portSpeed": "__NULL",
  • "ports": [
    ],
  • "profileName": "string",
  • "revert": true,
  • "rstpAdminEdgePort": true,
  • "stpBpduGuard": true,
  • "stpRootGuard": true,
  • "switchId": "string",
  • "switchMac": "string",
  • "taggedVlans": [
    ],
  • "tags": "string",
  • "untaggedVlan": "string",
  • "voiceVlan": 0,
  • "vsixEgressAcl": "string",
  • "vsixIngressAcl": "string"
}

Update Port Deprecated

Update switch's port setting. Use activity API with request id to get the status update.

path Parameters
switchId
required
string
Request Body schema:
required
arpInspectionTrust
boolean
dhcpSnoopingTrust
boolean
egressAcl
string
id
string
ignoreFieldSet
Array of strings unique
ignoreFields
string
ingressAcl
string
ipsg
boolean
lldpEnable
boolean
Array of objects (Switch_Service_API_&_Model_Documentation_LldpQosBo) unique
name
string
poeBudget
integer <int32>
poeCapability
boolean
poeClass
string
Enum: "__NULL" "UNSET" "ZERO" "ONE" "TWO" "THREE" "FOUR" "FIVE" "SIX" "SEVEN" "EIGHT"
poeEnable
boolean
poePriority
integer <int32>
port
string^(\d{1,2}/\d{1,2}/\d{1,2})(:\d{1,})?$
portEnable
boolean
portProtected
boolean
portSet
Array of strings unique
portSpeed
string
Enum: "__NULL" "UNSET" "NONE" "AUTO" "TEN_M_FULL" "TEN_M_HALF" "ONE_HUNDRED_M_FULL" "ONE_HUNDRED_M_HALF" "ONE_G_FULL" "ONE_G_FULL_MASTER" "ONE_G_FULL_SLAVE" "TWO_POINT_FIVE_G_FULL" "TWO_POINT_FIVE_G_FULL_MASTER" "TWO_POINT_FIVE_G_FULL_SLAVE" "FIVE_G_FULL" "FIVE_G_FULL_MASTER" "FIVE_G_FULL_SLAVE" "TEN_G_FULL" "TEN_G_FULL_MASTER" "TEN_G_FULL_SLAVE" "TWENTY_FIVE_G_FULL" "FORTY_G_FULL" "ONE_HUNDRED_G_FULL" "OPTIC"
ports
Array of strings unique
revert
boolean
rstpAdminEdgePort
boolean
stpBpduGuard
boolean
stpRootGuard
boolean
switchSerialNumber
string
taggedVlans
Array of strings unique
tags
string
untaggedVlan
string
voiceVlan
integer <int32> [ 1 .. 4095 ]

Responses

Request samples

Content type
{
  • "arpInspectionTrust": true,
  • "dhcpSnoopingTrust": true,
  • "egressAcl": "string",
  • "id": "string",
  • "ignoreFieldSet": [
    ],
  • "ignoreFields": "string",
  • "ingressAcl": "string",
  • "ipsg": true,
  • "lldpEnable": true,
  • "lldpQos": [
    ],
  • "name": "string",
  • "poeBudget": 0,
  • "poeCapability": true,
  • "poeClass": "__NULL",
  • "poeEnable": true,
  • "poePriority": 0,
  • "port": "string",
  • "portEnable": true,
  • "portProtected": true,
  • "portSet": [
    ],
  • "portSpeed": "__NULL",
  • "ports": [
    ],
  • "revert": true,
  • "rstpAdminEdgePort": true,
  • "stpBpduGuard": true,
  • "stpRootGuard": true,
  • "switchSerialNumber": "string",
  • "taggedVlans": [
    ],
  • "tags": "string",
  • "untaggedVlan": "string",
  • "voiceVlan": 1
}

Response samples

Content type
{
  • "arpInspectionTrust": true,
  • "dhcpSnoopingTrust": true,
  • "egressAcl": "string",
  • "id": "string",
  • "ignoreFields": "string",
  • "ingressAcl": "string",
  • "ipsg": true,
  • "lag": {
    },
  • "lldpEnable": true,
  • "lldpQos": [
    ],
  • "name": "string",
  • "poeBudget": 0.1,
  • "poeCapability": true,
  • "poeClass": "__NULL",
  • "poeEnable": true,
  • "poePriority": 0,
  • "port": "string",
  • "portEnable": true,
  • "portProtected": true,
  • "portSpeed": "__NULL",
  • "ports": [
    ],
  • "profileName": "string",
  • "revert": true,
  • "rstpAdminEdgePort": true,
  • "stpBpduGuard": true,
  • "stpRootGuard": true,
  • "switchId": "string",
  • "switchMac": "string",
  • "taggedVlans": [
    ],
  • "tags": "string",
  • "untaggedVlan": "string",
  • "voiceVlan": 0,
  • "vsixEgressAcl": "string",
  • "vsixIngressAcl": "string"
}

Power Cycle Port

Power cycle switch's port. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
Request Body schema:
required
Array
ports
Array of strings unique
switchId
string

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Ports

Get switch's port settings by switch id.

path Parameters
venueId
required
string
switchId
required
string

Responses

Response samples

Content type
[
  • {
    }
]

Get Ports

Get switch's port settings with port ids.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
[
  • {
    }
]

Update Port

Update switch's port setting. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
arpInspectionTrust
boolean
dhcpSnoopingTrust
boolean
egressAcl
string
id
string
ignoreFields
string
ingressAcl
string
ipsg
boolean
lldpEnable
boolean
Array of objects (Switch_Service_API_&_Model_Documentation_LldpQosViewV1001) unique
name
string
poeBudget
number <float>
poeCapability
boolean
poeClass
string
Enum: "__NULL" "UNSET" "ZERO" "ONE" "TWO" "THREE" "FOUR" "FIVE" "SIX" "SEVEN" "EIGHT"
poeEnable
boolean
poePriority
integer <int32>
port
string^(\d{1,2}/\d{1,2}/\d{1,2})(:\d{1,})?$
portEnable
boolean
portProtected
boolean
portSpeed
string
Enum: "__NULL" "UNSET" "NONE" "AUTO" "TEN_M_FULL" "TEN_M_HALF" "ONE_HUNDRED_M_FULL" "ONE_HUNDRED_M_HALF" "ONE_G_FULL" "ONE_G_FULL_MASTER" "ONE_G_FULL_SLAVE" "TWO_POINT_FIVE_G_FULL" "TWO_POINT_FIVE_G_FULL_MASTER" "TWO_POINT_FIVE_G_FULL_SLAVE" "FIVE_G_FULL" "FIVE_G_FULL_MASTER" "FIVE_G_FULL_SLAVE" "TEN_G_FULL" "TEN_G_FULL_MASTER" "TEN_G_FULL_SLAVE" "TWENTY_FIVE_G_FULL" "FORTY_G_FULL" "ONE_HUNDRED_G_FULL" "OPTIC"
ports
Array of strings unique
revert
boolean
rstpAdminEdgePort
boolean
stpBpduGuard
boolean
stpRootGuard
boolean
taggedVlans
Array of strings unique
tags
string
untaggedVlan
string
voiceVlan
integer <int32> [ 1 .. 4095 ]

Responses

Request samples

Content type
{
  • "arpInspectionTrust": true,
  • "dhcpSnoopingTrust": true,
  • "egressAcl": "string",
  • "id": "string",
  • "ignoreFields": "string",
  • "ingressAcl": "string",
  • "ipsg": true,
  • "lldpEnable": true,
  • "lldpQos": [
    ],
  • "name": "string",
  • "poeBudget": 0.1,
  • "poeCapability": true,
  • "poeClass": "__NULL",
  • "poeEnable": true,
  • "poePriority": 0,
  • "port": "string",
  • "portEnable": true,
  • "portProtected": true,
  • "portSpeed": "__NULL",
  • "ports": [
    ],
  • "revert": true,
  • "rstpAdminEdgePort": true,
  • "stpBpduGuard": true,
  • "stpRootGuard": true,
  • "taggedVlans": [
    ],
  • "tags": "string",
  • "untaggedVlan": "string",
  • "voiceVlan": 1
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Venue Template Switch Setting

Manage switch settings of venue template.

Get Venue Template Switch Setting

Get the switch settings of the venue template.

path Parameters
venueId
required
string

Responses

Response samples

Content type
{
  • "cliApplied": true,
  • "dns": [
    ],
  • "id": "string",
  • "name": "string",
  • "profileId": [
    ],
  • "switchLoginPassword": "string",
  • "switchLoginUsername": "string",
  • "syslogEnabled": true,
  • "syslogPrimaryServer": "string",
  • "syslogSecondaryServer": "string"
}

Update Venue Template Switch Setting

Update the switch settings of the venue template. Use activity API with request id to get the status update.

path Parameters
venueId
required
string
Request Body schema:
required
dns
Array of strings
id
string
profileId
Array of strings
syslogEnabled
boolean
syslogPrimaryServer
string
syslogSecondaryServer
string

Responses

Request samples

Content type
{
  • "dns": [
    ],
  • "id": "string",
  • "profileId": [
    ],
  • "syslogEnabled": true,
  • "syslogPrimaryServer": "string",
  • "syslogSecondaryServer": "string"
}

Response samples

Content type
{
  • "cliApplied": true,
  • "dns": [
    ],
  • "id": "string",
  • "name": "string",
  • "profileId": [
    ],
  • "switchLoginPassword": "string",
  • "switchLoginUsername": "string",
  • "syslogEnabled": true,
  • "syslogPrimaryServer": "string",
  • "syslogSecondaryServer": "string"
}

Command-Line Interface Template

Manage command-line interface templates.

Delete Command-Line Interface Templates

Delete command-line interface templates.

Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Command-Line Interface Templates Deprecated

Get a list of command-line interface templates.

Responses

Response samples

Content type
{
  • "applyLater": true,
  • "cli": "string",
  • "id": "string",
  • "name": "string",
  • "reload": true,
  • "variables": [
    ],
  • "venueSwitches": [
    ]
}

Add Command-Line Interface Template

Create a command-line interface template for switches.

Request Body schema:
required
applyLater
boolean
cli
string
id
string
name
string^.{1,64}$
reload
boolean
Array of objects (Switch_Service_API_&_Model_Documentation_AcxCliTemplateVariableBo) unique
Array of objects (Switch_Service_API_&_Model_Documentation_VenueSwitchBo)

Responses

Request samples

Content type
{
  • "applyLater": true,
  • "cli": "string",
  • "id": "string",
  • "name": "string",
  • "reload": true,
  • "variables": [
    ],
  • "venueSwitches": [
    ]
}

Response samples

Content type
{
  • "applyLater": true,
  • "cli": "string",
  • "id": "string",
  • "name": "string",
  • "reload": true,
  • "variables": [
    ],
  • "venueSwitches": [
    ]
}

Get Command-Line Interface Template-Examples

Get a list of command-line interface template examples.

query Parameters
category
string

Responses

Response samples

Content type
{
  • "cli": "string",
  • "id": "string",
  • "name": "string",
  • "version": "string"
}

Query Command-Line Interface Templates

Get a list of command-line interface templates by query.

Request Body schema:
required
fields
Array of strings
filterType
string
object
page
integer <int32>
pageSize
integer <int32>
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "filterType": "string",
  • "filters": {
    },
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Delete Command-Line Interface Template

Delete a command-line interface template by id.

path Parameters
cliTemplateId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Command-Line Interface Template

Get a command-line interface template by id.

path Parameters
cliTemplateId
required
string

Responses

Response samples

Content type
{
  • "applyLater": true,
  • "cli": "string",
  • "id": "string",
  • "name": "string",
  • "reload": true,
  • "variables": [
    ],
  • "venueSwitches": [
    ]
}

Update Command-Line Interface Template

Update a command-line interface template for switches by id.

path Parameters
cliTemplateId
required
string
Request Body schema:
required
applyLater
boolean
cli
string
id
string
name
string^.{1,64}$
reload
boolean
Array of objects (Switch_Service_API_&_Model_Documentation_AcxCliTemplateVariableBo) unique
Array of objects (Switch_Service_API_&_Model_Documentation_VenueSwitchBo)

Responses

Request samples

Content type
{
  • "applyLater": true,
  • "cli": "string",
  • "id": "string",
  • "name": "string",
  • "reload": true,
  • "variables": [
    ],
  • "venueSwitches": [
    ]
}

Response samples

Content type
{
  • "applyLater": true,
  • "cli": "string",
  • "id": "string",
  • "name": "string",
  • "reload": true,
  • "variables": [
    ],
  • "venueSwitches": [
    ]
}

Profile VLAN

Manage VLANs (virtual local area networks) of switch profile.

Delete Multiple VLANs Deprecated

Delete multiple VLANs of the switch profile.

path Parameters
switchProfileId
required
string
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Multiple VLANs Deprecated

Get multiple VLANs of the switch profile.

path Parameters
switchProfileId
required
string
query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 0,
  • "rootBridgeFamilyId": "__NULL",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "vlanId": 0,
  • "vlanName": "string"
}

Add VLAN

Create a VLAN of the switch profile.

path Parameters
switchProfileId
required
string
Request Body schema:
required
arpInspection
boolean
arpInspectionTrustPort
string
arpInspectionTrustPortList
Array of strings
arpTrustPortsList
Array of strings
defaultVlan
boolean
dhcpTrustPortsList
Array of strings
dummyVlan
boolean
enableAsDefaultVlan
required
boolean
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
igmpSnoopingTypeChanged
boolean
ipv4DhcpSnooping
boolean
ipv4DhcpSnoopingTrustPort
string
ipv4DhcpSnoopingTrustPortList
Array of strings
managementVlan
boolean
multicastVersion
integer <int32> [ 0 .. 3 ]
notDummyVlan
boolean
rapidSpanningTreeProtocol
boolean
rootBridgeFamilyId
string
Enum: "__NULL" "ICX7150" "ICX7250" "ICX7650" "ICX7850" "ICX7550" "ICX8200" "ICX8100"
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
spanningTreeProtocol
string
Enum: "rstp" "stp" "none"
Array of objects (Switch_Service_API_&_Model_Documentation_SwitchFamilyModelBo) unique
switchId
string
object (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo)
Array of objects (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo) unique
taggedPortsList
Array of strings
untaggedPortsList
Array of strings
vlanId
required
integer <int32> [ 1 .. 4095 ]
vlanName
string

Responses

Request samples

Content type
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "arpInspectionTrustPortList": [
    ],
  • "arpTrustPortsList": [
    ],
  • "defaultVlan": true,
  • "dhcpTrustPortsList": [
    ],
  • "dummyVlan": true,
  • "enableAsDefaultVlan": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "igmpSnoopingTypeChanged": true,
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "ipv4DhcpSnoopingTrustPortList": [
    ],
  • "managementVlan": true,
  • "multicastVersion": 3,
  • "notDummyVlan": true,
  • "rapidSpanningTreeProtocol": true,
  • "rootBridgeFamilyId": "__NULL",
  • "spanningTreePriority": 65535,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "switchId": "string",
  • "switchVlanPortModel": {
    },
  • "switchVlanPortModels": [
    ],
  • "taggedPortsList": [
    ],
  • "untaggedPortsList": [
    ],
  • "vlanId": 1,
  • "vlanName": "string"
}

Response samples

Content type
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 0,
  • "rootBridgeFamilyId": "__NULL",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "vlanId": 0,
  • "vlanName": "string"
}

Delete Profile VLAN Deprecated

Delete the specified VLAN of the switch profile.

path Parameters
switchProfileId
required
string
vlanId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Profile VLAN Deprecated

Get the specified VLAN of the switch profile.

path Parameters
switchProfileId
required
string
vlanId
required
string

Responses

Response samples

Content type
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 0,
  • "rootBridgeFamilyId": "__NULL",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "vlanId": 0,
  • "vlanName": "string"
}

Update VLAN Deprecated

Update the VLAN of the switch profile.

path Parameters
switchProfileId
required
string
vlanId
required
integer <int32>
Request Body schema:
required
arpInspection
boolean
arpInspectionTrustPort
string
arpInspectionTrustPortList
Array of strings
arpTrustPortsList
Array of strings
defaultVlan
boolean
dhcpTrustPortsList
Array of strings
dummyVlan
boolean
enableAsDefaultVlan
required
boolean
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
igmpSnoopingTypeChanged
boolean
ipv4DhcpSnooping
boolean
ipv4DhcpSnoopingTrustPort
string
ipv4DhcpSnoopingTrustPortList
Array of strings
managementVlan
boolean
multicastVersion
integer <int32> [ 0 .. 3 ]
notDummyVlan
boolean
rapidSpanningTreeProtocol
boolean
rootBridgeFamilyId
string
Enum: "__NULL" "ICX7150" "ICX7250" "ICX7650" "ICX7850" "ICX7550" "ICX8200" "ICX8100"
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
spanningTreeProtocol
string
Enum: "rstp" "stp" "none"
Array of objects (Switch_Service_API_&_Model_Documentation_SwitchFamilyModelBo) unique
switchId
string
object (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo)
Array of objects (Switch_Service_API_&_Model_Documentation_SwitchVlanPortModelBo) unique
taggedPortsList
Array of strings
untaggedPortsList
Array of strings
vlanId
required
integer <int32> [ 1 .. 4095 ]
vlanName
string

Responses

Request samples

Content type
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "arpInspectionTrustPortList": [
    ],
  • "arpTrustPortsList": [
    ],
  • "defaultVlan": true,
  • "dhcpTrustPortsList": [
    ],
  • "dummyVlan": true,
  • "enableAsDefaultVlan": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "igmpSnoopingTypeChanged": true,
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "ipv4DhcpSnoopingTrustPortList": [
    ],
  • "managementVlan": true,
  • "multicastVersion": 3,
  • "notDummyVlan": true,
  • "rapidSpanningTreeProtocol": true,
  • "rootBridgeFamilyId": "__NULL",
  • "spanningTreePriority": 65535,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "switchId": "string",
  • "switchVlanPortModel": {
    },
  • "switchVlanPortModels": [
    ],
  • "taggedPortsList": [
    ],
  • "untaggedPortsList": [
    ],
  • "vlanId": 1,
  • "vlanName": "string"
}

Response samples

Content type
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 0,
  • "rootBridgeFamilyId": "__NULL",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "vlanId": 0,
  • "vlanName": "string"
}

Retrieve VLANs Deprecated

List all usable VLANs for multiple ports of the same switch.

path Parameters
switchId
required
string

Responses

Response samples

Content type
{
  • "profileVlan": [
    ],
  • "switchDefaultVlan": [
    ],
  • "switchVlan": [
    ]
}

Get VLANs

Get a list of VLANs in profiles with the specified venue.

path Parameters
venueId
required
string

Responses

Response samples

Content type
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 0,
  • "rootBridgeFamilyId": "__NULL",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "vlanId": 0,
  • "vlanName": "string"
}

Retrieve VLANs

List all usable VLANs for multiple ports of the same switch.

path Parameters
venueId
required
string
switchId
required
string

Responses

Response samples

Content type
{
  • "profileVlan": [
    ],
  • "switchDefaultVlan": [
    ],
  • "switchVlan": [
    ]
}

Retrieve Tagged-VLANs Deprecated

List of venues switch-profile VLANs with specific model and tagged port.

path Parameters
venueId
required
string
Request Body schema:
required
model
string
Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" "ICX8200-24" "ICX8200-24P" "ICX8200-24F" "ICX8200-24FX" "ICX8200-24ZP" "ICX8200-48" "ICX8200-48F" "ICX8200-48P" "ICX8200-48PF" "ICX8200-48PF2" "ICX8200-48ZP2" "ICX8200-C08P" "ICX8200-C08PDC" "ICX8200-C08PF" "ICX8200-C08PT" "ICX8200-C08ZP" "ICX8100-24" "ICX8100-24P" "ICX8100-48" "ICX8100-48P" "ICX8100-C08PF"
port
string

Responses

Request samples

Content type
{
  • "model": "ICX7150-24",
  • "port": "string"
}

Response samples

Content type
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 0,
  • "rootBridgeFamilyId": "__NULL",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "vlanId": 0,
  • "vlanName": "string"
}

Retrieve Untagged-VLANs Deprecated

List of venues switch-profile VLANs with specific model and untagged port.

path Parameters
venueId
required
string
Request Body schema:
required
model
string
Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" "ICX8200-24" "ICX8200-24P" "ICX8200-24F" "ICX8200-24FX" "ICX8200-24ZP" "ICX8200-48" "ICX8200-48F" "ICX8200-48P" "ICX8200-48PF" "ICX8200-48PF2" "ICX8200-48ZP2" "ICX8200-C08P" "ICX8200-C08PDC" "ICX8200-C08PF" "ICX8200-C08PT" "ICX8200-C08ZP" "ICX8100-24" "ICX8100-24P" "ICX8100-48" "ICX8100-48P" "ICX8100-C08PF"
port
string

Responses

Request samples

Content type
{
  • "model": "ICX7150-24",
  • "port": "string"
}

Response samples

Content type
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 0,
  • "rootBridgeFamilyId": "__NULL",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "vlanId": 0,
  • "vlanName": "string"
}

Get VLANs Deprecated

List all of VLANs in profiles with the specified venue and the specific model.

path Parameters
venueId
required
string
query Parameters
model
required
string

Responses

Response samples

Content type
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 0,
  • "rootBridgeFamilyId": "__NULL",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels": [
    ],
  • "vlanId": 0,
  • "vlanName": "string"
}

Switch Access Control List

Manage ACLs (access control lists).

Get ACL

Get the ACL of the switch.

path Parameters
aclId
required
string

Responses

Response samples

Content type
{
  • "aclRules": [
    ],
  • "aclType": "standard",
  • "aclViewList": [
    ],
  • "id": "string",
  • "name": "string"
}

Get ACL Union Deprecated

List all usable ACLs for this switch (the union of venue and device levels).

path Parameters
switchId
required
string

Responses

Response samples

Content type
{
  • "profileAcl": [
    ],
  • "switchAcl": [
    ]
}

Get ACLs Deprecated

Get all ACLs of the switch.

path Parameters
switchId
required
string

Responses

Response samples

Content type
{
  • "aclRules": [
    ],
  • "aclType": "standard",
  • "aclViewList": [
    ],
  • "id": "string",
  • "name": "string"
}

Retrieve ACLs Deprecated

Query the switch's switch-level ACLs.

path Parameters
switchId
required
string
Request Body schema:
required
fields
Array of strings
filterType
string
object
page
integer <int32>
pageSize
integer <int32>
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "filterType": "string",
  • "filters": {
    },
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Get ACL Unions

List all usable ACLs for this switch (the union of venue and device levels).

path Parameters
venueId
required
string
switchId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "profileAcl": [
    ],
  • "switchAcl": [
    ]
}

Get Switch ACLs

Get all ACLs of the switch.

path Parameters
venueId
required
string
switchId
required
string

Responses

Response samples

Content type
[
  • {
    }
]

Query Switch ACLs

Get switch ACLs by query criteria.

path Parameters
venueId
required
string
switchId
required
string
Request Body schema:
required
fields
Array of strings
filterType
string
object
page
integer <int32>
pageSize
integer <int32>
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "fields": [
    ],
  • "filterType": "string",
  • "filters": {
    },
  • "page": 0,
  • "pageSize": 0,
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "data": [
    ],
  • "fields": [
    ],
  • "id": "string",
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Floor Plan

Manage floor-plans and calibration-points (calibrations-points are used to establish, for example, precise AP positioning).

Access Floor Plans

Get floor plans by a venue ID.

path Parameters
venueId
required
string

Responses

Response samples

Content type
[
  • {
    }
]

Request Floor Plan

Create floor plan.

path Parameters
venueId
required
string
Request Body schema:
required
floorNumber
required
integer <int32>

Floor number

id
string

Floor plan identifier

imageId
required
string

Image identifier

imageName
required
string

Image name

name
required
string

Floor plan name

venueId
string

Venue identifier

Responses

Request samples

Content type
{
  • "floorNumber": 0,
  • "id": "string",
  • "imageId": "string",
  • "imageName": "string",
  • "name": "string",
  • "venueId": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Query Floor Plans

Get floor plans by query criteria.

path Parameters
venueId
required
string
Request Body schema:
required
pageNumber
integer <int32>
pageSize
integer <int32>
sortBy
string
Enum: "FloorPlanName" "VenueName"

Responses

Request samples

Content type
{
  • "pageNumber": 0,
  • "pageSize": 0,
  • "sortBy": "FloorPlanName"
}

Response samples

Content type
{
  • "items": [
    ],
  • "totalPages": 0,
  • "totalSizes": 0
}

Revoke Floor Plan

Delete floor plan.

path Parameters
venueId
required
string
floorPlanId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": { }
}

Access Floor Plan

Get floor plan by ID.

path Parameters
venueId
required
string
floorPlanId
required
string

Responses

Response samples

Content type
{
  • "floorNumber": 0,
  • "id": "string",
  • "imageId": "string",
  • "imageName": "string",
  • "name": "string",
  • "venueId": "string"
}

Replace Floor Plan

Update floor plan.

path Parameters
venueId
required
string
floorPlanId
required
string
Request Body schema:
required
floorNumber
required
integer <int32>

Floor number

id
string

Floor plan identifier

imageId
required
string

Image identifier

imageName
required
string

Image name

name
required
string

Floor plan name

venueId
string

Venue identifier

Responses

Request samples

Content type
{
  • "floorNumber": 0,
  • "id": "string",
  • "imageId": "string",
  • "imageName": "string",
  • "name": "string",
  • "venueId": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Access Image Upload URL

Get a URL where to upload a floor plan image.

path Parameters
venueId
required
string
Request Body schema:
required
fileExtension
string

Responses

Request samples

Content type
{
  • "fileExtension": "string"
}

Response samples

Content type
{
  • "fileId": "string",
  • "signedUrl": "string"
}

Access Image Download URL

Get the URL where to download a floor plan image.

path Parameters
venueId
required
string
fileId
required
string

Responses

Response samples

Content type
{
  • "fileId": "string",
  • "signedUrl": "string"
}

Venue

Manage venue.

Access Venues

Get venue list.

Responses

Response samples

Content type
[
  • {
    }
]

Request Venue

Create venue.

Request Body schema:
required
required
object (Venue_Service_API_&_Model_Documentation_AddressView)
description
string

Venue description

Array of objects (Venue_Service_API_&_Model_Documentation_FloorPlanView)
id
string

Venue identifier

isTemplate
boolean
name
required
string [ 2 .. 32 ] characters \s*\S+\s*\S+.*

Venue name

tags
Array of strings

Responses

Request samples

Content type
{
  • "address": {
    },
  • "description": "string",
  • "floorPlans": [
    ],
  • "id": "string",
  • "isTemplate": true,
  • "name": "string",
  • "tags": [
    ]
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Revoke Venue by ID

Delete venues by ID. WARNING: Note that all network devices under this venue will be removed as well.

path Parameters
venueId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string",
  • "response": { }
}

Access Venue by ID

Get venue.

path Parameters
venueId
required
string

Responses

Response samples

Content type
{
  • "address": {
    },
  • "description": "string",
  • "floorPlans": [
    ],
  • "id": "string",
  • "isTemplate": true,
  • "name": "string",
  • "tags": [
    ]
}

Replace Venue

Update venue.

path Parameters
venueId
required
string
Request Body schema:
required
required
object (Venue_Service_API_&_Model_Documentation_AddressView)
description
string

Venue description

Array of objects (Venue_Service_API_&_Model_Documentation_FloorPlanView)
id
string

Venue identifier

isTemplate
boolean
name
required
string [ 2 .. 32 ] characters \s*\S+\s*\S+.*

Venue name

tags
Array of strings

Responses

Request samples

Content type
{
  • "address": {
    },
  • "description": "string",
  • "floorPlans": [
    ],
  • "id": "string",
  • "isTemplate": true,
  • "name": "string",
  • "tags": [
    ]
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

View MSP

View MSP and VAR information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Get Delegations

Get the list of customer delegations.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "alarmCount": 0,
  • "crtTime": "string",
  • "delegatedToEmail": "string",
  • "delegatedToId": "string",
  • "delegatedToName": "string",
  • "delegationType": "string",
  • "earlyExpirationDate": "string",
  • "entitlements": [
    ],
  • "id": "string",
  • "lastUpdTime": "string",
  • "priorityIncidents": {
    },
  • "status": "string",
  • "switchLicenses": 0,
  • "tenantEmail": "string",
  • "tenantId": "string",
  • "tenantName": "string",
  • "type": "string",
  • "wifiLicenses": 0
}

Query MSP-ECs

Query MSP-ECs.

query Parameters
delegation
string
Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get EC Inventory

View the list of networking devices installed in our end customers venues.

path Parameters
mspTenantId
required
string

Tenant Id of the MSP.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Export EC Inventory

Export the list of networking devices installed in our end customers venues.

path Parameters
mspTenantId
required
string

Tenant Id of the MSP.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{ }

Query MSP-ECs for Tech Partner

Query MSP-ECs for tech partner.

query Parameters
delegation
string
Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

View VLAN Pool Profiles

Manage VLAN Pool Profile.

Query VLAN Pool Profiles

Query VLAN pool profiles.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

View Switch

View Switch information. Note: this set of endpoints is used to view operational data. They don't provide the means to manage configuration.

Get Switches Aggregation Details Deprecated

Get parameters and operational data for a list of switches with aggregation details.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Switch Clients Deprecated

Get a list of switch clients (i.e., end-user devices).

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Ports Deprecated

Get a list of parameters for the switch's ports.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Export Switch Inventory Deprecated

Export the list of switches belong to the tenant.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{ }

Get Switches Aggregation Details

Get parameters and operational data for a list of switches with aggregation details.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Switch Clients

Get a list of switch clients (i.e., end-user devices).

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Switches of Venue

Get a list of switches of venue.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Export Switch Inventory

Export the list of switches belong to the tenant.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{ }

Query Switch Ports

Get a list of parameters for the switch's ports.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

View Venue

View venue information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Get Venues

Return a list of venue records.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "addressLine": "string",
  • "city": "string",
  • "country": "string",
  • "countryCode": "string",
  • "crtTime": "string",
  • "description": "string",
  • "dhcp": {
    },
  • "dpGroupId": "string",
  • "id": "string",
  • "isTemplate": true,
  • "lastUpdTime": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "mesh": {
    },
  • "name": "string",
  • "notes": "string",
  • "rogueDetection": {
    },
  • "switchProfileId": "string",
  • "switchProfileName": "string",
  • "syslogServer": {
    },
  • "tenantId": "string",
  • "timeZone": "string",
  • "type": "string",
  • "wifiFirmwareVersion": "string"
}

Get Venue AP Models Deprecated

This API is deprecated. Please use the latest API. The deprecated API is used to retrieve the AP models deployed in this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "models": [
    ]
}

Get Venue AP Models

Get the AP models deployed in this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "models": [
    ]
}

Get Venue Rogue APs

Get the list of rogue APs located in this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

View Wi-Fi Profile

View Wi-Fi Service & Policy information

Get Access Control Profiles

Get data for a list of access control profiles.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Application Policies

Get data for a list of application policies.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Device Policies

Get data for a list of device policies.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get DHCP Configuration Service Profiles

Query DHCP configuration service profiles for the list.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Access Control Profiles Deprecated

Get data for a list of access control profiles.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Application Policies Deprecated

Get data for a list of application policies.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Device Policies Deprecated

Get data for a list of device policies.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get DHCP Configuration Service Profiles Deprecated

Get data for a list of DHCP configuration service profiles.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Client Isolation Allowlists Deprecated

Get data for a list of client isolation allowlists.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Layer Two Policies Deprecated

Get data for a list of layer 2 policies.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Layer Three Policies Deprecated

Get data for a list of layer 3 policies.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Multicast DNS Proxy Profiles Deprecated

Get data for a list of multicast DNS proxy service profiles.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get RADIUS Server Profiles Deprecated

Get data for a list of RADIUS server profiles.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Rogue AP Policy Profiles Deprecated

Get data for a list of rogue AP policies.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Syslog Server Profiles Deprecated

Get data for a list of syslog server profiles.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get VLAN Pool Profiles Deprecated

Get data for a list of VLAN pool policy profiles.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Wifi Calling Profiles Deprecated

Get data for a list of wifi calling service profiles.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Layer Two Policies

Get data for a list of layer 2 policies.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Layer Three Policies

Get data for a list of layer 3 policies.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Multicast DNS Proxy Profiles

Get data for a list of multicast DNS proxy service profiles.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get RADIUS Server Profiles

Get data for a list of RADIUS server profiles.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Rogue Policies

Get the list of rogue policies in this tenant.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Syslog Server Profiles

Get data for a list of syslog server profiles.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Tunnel Profiles

Get data for a list of tunnel profiles. This is only permitted for users with feature flag edge role.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Wifi Calling Profiles

Get data for a list of wifi calling service profiles.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

View Portal Service Profiles

Manage Portal Service Profile.

Query Portal Service Profiles

Query portal service profile for the list.

Request Body schema: application/vnd.ruckus.v1.1+json
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
application/vnd.ruckus.v1.1+json
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
application/vnd.ruckus.v1.1+json
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

network

Network API

Get Wi-Fi Networks data

Get Wi-Fi Network Information

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "ancillarySsid": "string",
  • "apSerialNumbers": [
    ],
  • "captiveType": "string",
  • "clientCount": 0,
  • "cloudpathServerId": "string",
  • "crtTime": "string",
  • "defaultGuestCountry": "string",
  • "description": "string",
  • "dsaeOnboardNetwork": {
    },
  • "enableDhcp": true,
  • "id": "string",
  • "isOweMaster": true,
  • "lastUpdTime": "string",
  • "name": "string",
  • "nwSubType": "string",
  • "nwType": "string",
  • "owePairNetworkId": "string",
  • "securityProtocol": "string",
  • "ssid": "string",
  • "tunnelWlanEnable": true,
  • "venueApGroups": [
    ],
  • "vlan": 0
}

View Client Isolation Profiles

Manage Client Isolation Profile.

Query Client Isolation Profiles

Query client isolation profile for the list.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

View Venue Topology

View Venue Topology information.

Get Mesh Topology

Get venue's mesh topology data.

path Parameters
venueId
required
string

Responses

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Topology

Get venue's topology data.

path Parameters
venueId
required
string
query Parameters
meshOnly
required
boolean

Get mesh topology

Responses

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Quality of Service

View the information of Quality of Service

Get the Statistics of Quality of Service

Retrieve the list of quality of service statistics.

Request Body schema:
required
Array
Array
field
string
value
string

Responses

Request samples

Content type
[
  • [
    ]
]

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

View Platform

View platform information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Get Venues

Return a list of venue records.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "addressLine": "string",
  • "city": "string",
  • "country": "string",
  • "countryCode": "string",
  • "crtTime": "string",
  • "description": "string",
  • "dhcp": {
    },
  • "dpGroupId": "string",
  • "id": "string",
  • "isTemplate": true,
  • "lastUpdTime": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "mesh": {
    },
  • "name": "string",
  • "notes": "string",
  • "rogueDetection": {
    },
  • "switchProfileId": "string",
  • "switchProfileName": "string",
  • "syslogServer": {
    },
  • "tenantId": "string",
  • "timeZone": "string",
  • "type": "string",
  • "wifiFirmwareVersion": "string"
}

Get Venue AP Models Deprecated

This API is deprecated. Please use the latest API. The deprecated API is used to retrieve the AP models deployed in this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "models": [
    ]
}

Get Venue AP Models

Get the AP models deployed in this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "models": [
    ]
}

Get Venue Rogue APs

Get the list of rogue APs located in this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

View SNMP Agent Profiles

Manage SNMP Agent Profile.

Query SNMP Agent Profiles

Query SNMP agent profile for the list.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

View Wi-Fi

View Wi-Fi information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Get APs Aggregation Details

Get parameters and operational data for a list of APs with aggregation details.

Request Body schema: application/json
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
application/json
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get APs

Get parameters and operational data for a list of APs or mesh APs.

query Parameters
mesh
boolean
Default: false

Get mesh aps

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Export AP Inventory

Export the list of APs belong to the tenant.

Request Body schema: application/json
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
application/json
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
application/json
{ }

Get AP Clients

Get client (i.e., end-user devices) parameters and operational data.

query Parameters
apSerialNumber
string
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Get Client by MAC

Get extended set of parameters and operational data for the client having this MAC address.

path Parameters
mac
required
string

Responses

Response samples

Content type
{
  • "apMac": "string",
  • "apName": "string",
  • "apSerialNumber": "string",
  • "bssid": "string",
  • "connectedSince": "string",
  • "healthCheckStatus": "string",
  • "hostname": "string",
  • "ip": "string",
  • "mac": "string",
  • "networkId": "string",
  • "noiseFloor_dBm": 0,
  • "osType": "string",
  • "radioChannel": 0,
  • "receiveSignalStrength_dBm": 0,
  • "rxBytes": 0,
  • "rxPackets": 0,
  • "snr_dB": 0,
  • "ssid": "string",
  • "switchMac": "string",
  • "switchName": "string",
  • "switchSerialNumber": "string",
  • "txBytes": 0,
  • "txDropDataPacket": 0,
  • "txPackets": 0,
  • "username": "string",
  • "venueId": "string",
  • "venueName": "string",
  • "vlan": 0,
  • "vni": 0
}

Get Cloudpath Servers

Get a list of Cloudpath server information.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get Guests

Get guests.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Export Guest CSV Deprecated

Export guest to CSV.

Request Body schema:
required
dateFormat
string
guestIds
Array of strings unique
timezone
string

Responses

Request samples

Content type
{
  • "dateFormat": "string",
  • "guestIds": [
    ],
  • "timezone": "string"
}

Query AP Groups

Query AP groups information.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Get APs

Get parameters and operational data for a list of APs or mesh APs.

query Parameters
mesh
boolean
Default: false

Get mesh aps

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

SmartEdge SD-LAN Status

View SmartEdge SD-LAN Status information

Get SmartEdge SD-LANs

Get SD-LAN list of SmartEdge.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

Network

Network API

Get Wi-Fi Networks data

Get Wi-Fi Network Information

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "ancillarySsid": "string",
  • "apSerialNumbers": [
    ],
  • "captiveType": "string",
  • "clientCount": 0,
  • "cloudpathServerId": "string",
  • "crtTime": "string",
  • "defaultGuestCountry": "string",
  • "description": "string",
  • "dsaeOnboardNetwork": {
    },
  • "enableDhcp": true,
  • "id": "string",
  • "isOweMaster": true,
  • "lastUpdTime": "string",
  • "name": "string",
  • "nwSubType": "string",
  • "nwType": "string",
  • "owePairNetworkId": "string",
  • "securityProtocol": "string",
  • "ssid": "string",
  • "tunnelWlanEnable": true,
  • "venueApGroups": [
    ],
  • "vlan": 0
}

venue

Get Venues

Return a list of venue records.

Request Body schema:
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
{
  • "addressLine": "string",
  • "city": "string",
  • "country": "string",
  • "countryCode": "string",
  • "crtTime": "string",
  • "description": "string",
  • "dhcp": {
    },
  • "dpGroupId": "string",
  • "id": "string",
  • "isTemplate": true,
  • "lastUpdTime": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "mesh": {
    },
  • "name": "string",
  • "notes": "string",
  • "rogueDetection": {
    },
  • "switchProfileId": "string",
  • "switchProfileName": "string",
  • "syslogServer": {
    },
  • "tenantId": "string",
  • "timeZone": "string",
  • "type": "string",
  • "wifiFirmwareVersion": "string"
}

AP SNMP Agents

Get AP SNMP Agents Deprecated

Get data for a list of AP SNMP agents.

Request Body schema: application/json
required
exists
string
fields
Array of strings unique
object
groupBy
string
Array of objects (ViewModel_Service_API_&_Model_Documentation_MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (ViewModel_Service_API_&_Model_Documentation_MustNotMatchFieldDto)
page
integer <int32>
object
pageSize
integer <int32>
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
object (ViewModel_Service_API_&_Model_Documentation_RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortByCountField
string
sortField
string
sortOrder
string
object (ViewModel_Service_API_&_Model_Documentation_TermFieldDto)
object

Responses

Request samples

Content type
application/json
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "groupBy": "string",
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortByCountField": "string",
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    },
  • "terms": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [],
  • "totalCount": 0
}

VLAN Pool Profile

Manage VLAN pool profiles.

Deactivate VLAN Pool Profile On AP Group

Use this API command to deactivate a VLAN pool profile on an AP group.

path Parameters
venueId
required
string

Venue ID

wifiNetworkId
required
string

Wi-Fi Network ID

apGroupId
required
string

AP Group ID

vlanPoolProfileId
required
string

VLAN Pool Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate VLAN Pool Profile On AP Group

Use this API command to activate a VLAN pool profile on an AP group.

path Parameters
venueId
required
string

Venue ID

wifiNetworkId
required
string

Wi-Fi Network ID

apGroupId
required
string

AP Group ID

vlanPoolProfileId
required
string

VLAN Pool Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Add VLAN Pool Profile

Use this API command to create a new VLAN pool profile.

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

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete VLAN Pool Profile

Use this API command to delete a VLAN pool profile.

path Parameters
vlanPoolProfileId
required
string

VLAN Pool Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get VLAN Pool

Use this API command to get the VLAN pool profile details.

path Parameters
vlanPoolProfileId
required
string

VLAN Pool Profile ID

Responses

Response samples

Content type
{
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "vlanMembers": [
    ]
}

Update VLAN Pool Profile

Use this API command to update a VLAN pool profile.

path Parameters
vlanPoolProfileId
required
string

VLAN Pool Profile ID

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

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate VLAN Pool Profile On Wi-Fi Network

Use this API command to deactivate a VLAN pool profile on a Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

vlanPoolProfileId
required
string

VLAN Pool Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate VLAN Pool Profile On Wi-Fi Network

Use this API command to activate a VLAN pool profile on a Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

vlanPoolProfileId
required
string

VLAN Pool Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Wi-Fi Calling Service Profile

Manage Wi-Fi calling service profiles.

Delete Wi-Fi Calling Service Profiles Deprecated

Delete a list of Wi-Fi calling service profiles. Use DELETE /wifiCallingServiceProfiles/{wifiCallingServiceProfileId} instead.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get Wi-Fi Calling Service Profiles Deprecated

Get the Wi-Fi calling service profiles.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Wi-Fi Calling Service Profile

Create a new Wi-Fi calling service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
required
description
string [ 2 .. 180 ] characters
required
Array of objects (Wi-Fi_API_and_Model_Documentation_Epdg) [ 1 .. 5 ] items
networkIds
Array of strings
Deprecated
qosPriority
string
Default: "QosPriorityEnum.WIFICALLING_PRI_VOICE"
Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG"
serviceName
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Content type
{
  • "description": "string",
  • "epdgs": [
    ],
  • "networkIds": [
    ],
  • "qosPriority": "WIFICALLING_PRI_VOICE",
  • "serviceName": "string"
}

Response samples

Content type
{
  • "requestId": "string"
}

Delete Wi-Fi Calling Service Profile

Delete a Wi-Fi calling service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
wifiCallingServiceProfileId
required
string

Wi-Fi Calling Service Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Wi-Fi Calling Service Profile

Get the Wi-Fi calling service profile details. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
wifiCallingServiceProfileId
required
string

Wi-Fi calling profile ID

Responses

Response samples

Content type
{
  • "description": "string",
  • "epdgs": [
    ],
  • "id": "string",
  • "networkIds": [
    ],
  • "qosPriority": "WIFICALLING_PRI_VOICE",
  • "serviceName": "string"
}

Update Wi-Fi Calling Service Profile

Update a Wi-Fi calling service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
wifiCallingServiceProfileId
required
string

Wi-Fi Calling Service Profile ID

Request Body schema:
required
description
string [ 2 .. 180 ] characters
required
Array of objects (Wi-Fi_API_and_Model_Documentation_Epdg) [ 1 .. 5 ] items
networkIds
Array of strings
Deprecated
qosPriority
string
Default: "QosPriorityEnum.WIFICALLING_PRI_VOICE"
Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG"
serviceName
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Content type
{
  • "description": "string",
  • "epdgs": [
    ],
  • "networkIds": [
    ],
  • "qosPriority": "WIFICALLING_PRI_VOICE",
  • "serviceName": "string"
}

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate Wi-Fi Calling Service Profile On Wi-Fi Network

Deactivate a Wi-Fi calling service profile on a Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

wifiCallingServiceProfileId
required
string

Wi-Fi Calling Service Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Wi-Fi Calling Service Profile On Wi-Fi Network

Activate a Wi-Fi calling service profile on a Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

wifiCallingServiceProfileId
required
string

Wi-Fi Calling Service Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Rogue AP Detection Policy

Manage Rogue AP Detection Policies for New UI.

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 AP Detection Policies Deprecated

Delete a list of rogue AP detection policies. Use DELETE /roguePolicies/{roguePolicyId} instead.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get Rogue AP Detection Policies Deprecated

Get a list of rogue AP detection policies. Use POST /roguePolicies/query instead.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Rogue AP Detection Policy Deprecated

Create a rogue AP detection policy. Use POST /roguePolicies instead.

Request Body schema: application/json
required
description
string [ 0 .. 255 ] characters
name
required
string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
Array of objects (Wi-Fi_API_and_Model_Documentation_RogueClassificationPolicyRule)
Array of objects (Wi-Fi_API_and_Model_Documentation_IdAndName)
Deprecated

Responses

Request samples

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

Response samples

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

Delete Rogue AP Detection Policy Deprecated

Delete this rogue AP detection policy. Use DELETE /roguePolicies/{roguePolicyId} instead.

path Parameters
roguePolicyId
required
string

Rogue AP Detection Policy ID.

Responses

Response samples

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

Get Rogue AP Detection Policy Deprecated

Get this rogue AP detection policy. Use GET /roguePolicies/{roguePolicyId} instead.

path Parameters
roguePolicyId
required
string

Rogue AP Detection Policy ID.

Responses

Response samples

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

Update Rogue AP Detection Policy Deprecated

Update this rogue AP detection policy. Use PUT /roguePolicies/{roguePolicyId} instead.

path Parameters
roguePolicyId
required
string

Rogue AP Detection Policy ID.

Request Body schema: application/json
required
description
string [ 0 .. 255 ] characters
name
required
string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
Array of objects (Wi-Fi_API_and_Model_Documentation_RogueClassificationPolicyRule)
Array of objects (Wi-Fi_API_and_Model_Documentation_IdAndName)
Deprecated

Responses

Request samples

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

Response samples

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

Unbind Rogue AP Detection Policy from Venues Deprecated

Delete the binding between a rogue AP detection policy and its list of venues and apply the default policy to those venues instead. Note that unbinding a policy from a venue does not disable rogue AP detection in that venue. Use DELETE /venues/{venueId}/roguePolicies/{roguePolicyId} instead.

path Parameters
roguePolicyId
required
string

Rogue AP Detection Policy ID.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Create Rogue AP Detection Policy Venue Bindings Deprecated

Bind a rogue AP detection policy to a list of venues. Use PUT /venues/{venueId}/roguePolicies/{roguePolicyId} instead.

path Parameters
roguePolicyId
required
string

Rogue AP Detection Policy ID.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Create Rogue AP Detection Policy

Create a rogue AP detection policy.

Request Body schema:
required
description
string [ 0 .. 255 ] characters
name
required
string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
Array of objects (Wi-Fi_API_and_Model_Documentation_RogueClassificationPolicyRule)

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Rogue AP Detection Policy

Delete this rogue AP detection policy.

path Parameters
roguePolicyId
required
string

Rogue AP Detection Policy ID.

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Rogue AP Detection Policy

Get this rogue AP detection policy.

path Parameters
roguePolicyId
required
string

Rogue AP Detection Policy ID.

Responses

Response samples

Content type
{
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "rules": [
    ]
}

Update Rogue AP Detection Policy

Update this rogue AP detection policy.

path Parameters
roguePolicyId
required
string

Rogue AP Detection Policy ID.

Request Body schema:
required
description
string [ 0 .. 255 ] characters
name
required
string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
Array of objects (Wi-Fi_API_and_Model_Documentation_RogueClassificationPolicyRule)

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate Rogue AP Detection Policy On Venue

Deactivate a rogue AP detection policy on a venue and apply the default policy to that venue instead. Note that deactivate a policy from a venue does not disable rogue AP detection in that venue.

path Parameters
venueId
required
string

Venue ID.

roguePolicyId
required
string

Rogue AP Detection Policy ID.

Responses

Response samples

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

Activate Rogue AP Detection Policy On Venue

Activate a rogue AP detection policy on a venue.

path Parameters
venueId
required
string

Venue ID.

roguePolicyId
required
string

Rogue AP Detection Policy ID.

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Venue Rogue Policy Settings

Get the venue rogue policy settings.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "reportThreshold": 0
}

Update Venue Rogue Policy Settings

Update the venue rogue policy settings.

path Parameters
venueId
required
string

Venue ID

Request Body schema:
required
reportThreshold
integer <int32> [ 0 .. 100 ]
Default: 0

Responses

Request samples

Content type
{
  • "reportThreshold": 0
}

Response samples

Content type
{
  • "requestId": "string"
}

Wi-Fi Network Activation

Manage Wi-Fi network-venue activation relationships.

Delete Network Activation Deprecated

Delete a list of network-venue activation.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Create Network Activation Deprecated

Create a new network-venue activation.

Request Body schema: application/json
required
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 (Wi-Fi_API_and_Model_Documentation_NetworkApGroup)
clientIsolationAllowlistId
string
isAllApGroups
boolean
Default: true
networkId
string
object (Wi-Fi_API_and_Model_Documentation_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",
  • "response": {
    }
}

Create Network Activation Mappings Deprecated

Create multiple network-venue activations.

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

Network-Venue scheduler

venueId
string
vlanPoolId
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Get Network Activations by Query Filter Deprecated

Get network-venue activation list.

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

Responses

Request samples

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

Response samples

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

Delete Network Activation Deprecated

Delete a network-venue activation.

path Parameters
networkVenueId
required
string

Network-venue activation ID

Responses

Response samples

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

Get Network Activation Deprecated

Get the network-venue activation details.

path Parameters
networkVenueId
required
string

Network-venue activation 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 Activation Deprecated

Update this network-venue activation.

path Parameters
networkVenueId
required
string

Network-venue activation ID

Request Body schema: application/json
required
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 (Wi-Fi_API_and_Model_Documentation_NetworkApGroup)
clientIsolationAllowlistId
string
isAllApGroups
boolean
Default: true
networkId
string
object (Wi-Fi_API_and_Model_Documentation_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"
}

AP

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

Get APs by AP-Group Deprecated

Get the APs in the AP-group.

path Parameters
apGroupId
required
string

AP-group ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete APs Deprecated

Delete a list of APs.

query Parameters
resetFirmware
boolean
Default: false

Reset AP firmware to Standalone image.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get APs Deprecated

Get the AP list.

query Parameters
operational
boolean
Default: false

Include operational data in response

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add APs Deprecated

Add a list of new APs.

Request Body schema:
required
Array
apGroupId
string
description
string [ 0 .. 180 ] characters
object (Wi-Fi_API_and_Model_Documentation_DeviceGps)

Ap or Venue latitude and longitude

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

AP position object

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

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Get Result for Import APs from CSV File Deprecated

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"
}

Delete AP Deprecated

Delete an AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

query Parameters
resetFirmware
boolean
Default: false

Reset AP firmware to Standalone image.

Responses

Response samples

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

Get AP Deprecated

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": {
    },
  • "bssColoring": {
    },
  • "clientAdmissionControl": {
    },
  • "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 Deprecated

Trigger AP action.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
required
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",
  • "response": {
    }
}

Update AP Deprecated

Update an AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
required
apGroupId
string
description
string [ 0 .. 180 ] characters
object (Wi-Fi_API_and_Model_Documentation_DeviceGps)

Ap or Venue latitude and longitude

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

AP position object

serialNumber
required
string^[1-9][0-9]{11}$
tags
Array of strings [ 0 .. 24 ] items [ items [ 0 .. 24 ] characters ]
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 Basic Service Set Coloring Settings Deprecated

Get basic service set coloring settings of this AP.

path Parameters
serialNumber
required
string

The serial number of the AP

Responses

Response samples

Content type
application/json
{
  • "bssColoringEnabled": false,
  • "useVenueSettings": true
}

Update AP Basic Service Set Coloring Settings Deprecated

Update basic service set coloring settings of this AP.

path Parameters
serialNumber
required
string

The serial number of the AP

Request Body schema: application/json
required
bssColoringEnabled
boolean
Default: false
useVenueSettings
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "bssColoringEnabled": false,
  • "useVenueSettings": true
}

Response samples

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

Get AP Capabilities Deprecated

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

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

Get AP Default Regulatory-Channels Deprecated

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": {
    }
}

Reset AP Client Admission Control Settings Deprecated

Reset the client admission control settings of this AP to the default values.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get AP Client Admission Control Settings Deprecated

Get the client admission control settings of this AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "enable24G": false,
  • "enable50G": false,
  • "maxRadioLoad24G": 75,
  • "maxRadioLoad50G": 75,
  • "minClientCount24G": 10,
  • "minClientCount50G": 20,
  • "minClientThroughput24G": 0,
  • "minClientThroughput50G": 0,
  • "useVenueSettings": true
}

Update AP Client Admission Control Settings Deprecated

Update the client admission control settings of this AP.

path Parameters
serialNumber
required
string

The serial number of the AP

Request Body schema:
required
enable24G
boolean
Default: false
enable50G
boolean
Default: false
maxRadioLoad24G
integer <int32> [ 50 .. 100 ]
Default: 75
maxRadioLoad50G
integer <int32> [ 50 .. 100 ]
Default: 75
minClientCount24G
integer <int32> [ 0 .. 100 ]
Default: 10
minClientCount50G
integer <int32> [ 0 .. 100 ]
Default: 20
minClientThroughput24G
integer <int32> [ 0 .. 100 ]
Default: 0
minClientThroughput50G
integer <int32> [ 0 .. 100 ]
Default: 0
useVenueSettings
boolean
Default: true

Responses

Request samples

Content type
{
  • "enable24G": false,
  • "enable50G": false,
  • "maxRadioLoad24G": 75,
  • "maxRadioLoad50G": 75,
  • "minClientCount24G": 10,
  • "minClientCount50G": 20,
  • "minClientThroughput24G": 0,
  • "minClientThroughput50G": 0,
  • "useVenueSettings": true
}

Response samples

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

Get DHCP Lease Times Deprecated

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 Deprecated

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 Deprecated

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 Deprecated

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 Deprecated

Update directed multicast settings of this AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
required
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 Deprecated

Update an AP floor-plan position.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
required
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 Deprecated

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 Deprecated

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 Deprecated

Update LAN-ports of an AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
required
Array of objects (Wi-Fi_API_and_Model_Documentation_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"
}

Reset AP LED Deprecated

Reset the LED 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 LED Deprecated

Get AP LED settings.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "ledEnabled": false,
  • "useVenueSettings": false
}

Update AP LED Deprecated

Update LED of an AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
required
ledEnabled
boolean
Default: false
useVenueSettings
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "ledEnabled": false,
  • "useVenueSettings": false
}

Response samples

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

Download AP Log Deprecated

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"
}

Get AP Mesh Settings Deprecated

Get mesh settings for this AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "meshMode": "AUTO",
  • "uplinkMacAddresses": [
    ],
  • "uplinkMode": "SMART",
  • "venueMeshEnabled": false
}

Update AP Mesh Settings Deprecated

Update mesh settings of this AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
required
meshMode
string
Default: "MeshModeEnum.AUTO"
Enum: "AUTO" "ROOT" "MESH" "DISABLED"
uplinkMacAddresses
Array of strings
uplinkMode
string
Default: "MeshUplinkModeEnum.SMART"
Enum: "SMART" "MANUAL"

Responses

Request samples

Content type
application/json
{
  • "meshMode": "AUTO",
  • "uplinkMacAddresses": [
    ],
  • "uplinkMode": "SMART"
}

Response samples

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

Reset AP Network Settings Deprecated

Reset AP network settings.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

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

Get AP Network Settings Deprecated

Get network settings for this AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "gateway": "string",
  • "ip": "string",
  • "ipType": "DYNAMIC",
  • "netmask": "string",
  • "primaryDnsServer": "string",
  • "secondaryDnsServer": "string"
}

Update AP Network Settings Deprecated

Update network settings of this AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
required
gateway
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
ip
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
ipType
required
string
Enum: "DYNAMIC" "STATIC"
netmask
string^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128...
primaryDnsServer
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
secondaryDnsServer
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...

Responses

Request samples

Content type
application/json
{
  • "gateway": "string",
  • "ip": "string",
  • "ipType": "DYNAMIC",
  • "netmask": "string",
  • "primaryDnsServer": "string",
  • "secondaryDnsServer": "string"
}

Response samples

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

Stop Packet Capture Deprecated

Stop packet capture.

path Parameters
serialNumber
required
string
Request Body schema: application/json
required
sessionId
string

Responses

Request samples

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

Response samples

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

Get Packet Capture State Deprecated

Get packet capture state.

path Parameters
serialNumber
required
string

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string",
  • "fileName": "string",
  • "fileUrl": "string",
  • "sessionId": "string",
  • "status": "IDLE"
}

Start Packet Capture Deprecated

Start packet capture.

path Parameters
serialNumber
required
string
Request Body schema: application/json
required
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",
  • "response": {
    }
}

Delete AP Picture Deprecated

Delete AP picture.

path Parameters
serialNumber
required
string

Responses

Response samples

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

Get AP Picture Deprecated

Get AP picture.

path Parameters
serialNumber
required
string

Responses

Response samples

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

Upload AP Picture Deprecated

Upload AP picture.

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

Responses

Response samples

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

Reset AP Radio Customization Deprecated

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 Deprecated

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 Deprecated

Update an AP radio settings.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
required
object (Wi-Fi_API_and_Model_Documentation_ApRadioParams24G)

AP radio customization for 2.4GHz.

object (Wi-Fi_API_and_Model_Documentation_ApRadioParams50G)

AP radio customization for 5GHz.

object (Wi-Fi_API_and_Model_Documentation_ApRadioParams6G)

AP radio customization for 6GHz.

object (Wi-Fi_API_and_Model_Documentation_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 SNMP Agent Settings Deprecated

Reset AP SNMP agent 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 SNMP Agent Settings Deprecated

Get SNMP agent settings for this AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
application/json
{
  • "apSnmpAgentProfileId": "string",
  • "enableApSnmp": false,
  • "useVenueSettings": true
}

Update AP SNMP Agent Settings Deprecated

Update SNMP agent settings of this AP.

path Parameters
serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
required
apSnmpAgentProfileId
string
enableApSnmp
boolean
Default: false
useVenueSettings
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "apSnmpAgentProfileId": "string",
  • "enableApSnmp": false,
  • "useVenueSettings": true
}

Response samples

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

Reset AP Customization Deprecated

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 Deprecated

GET AP customization details.

path Parameters
serialNumber
required
string

Responses

Response samples

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

Update AP Customization Deprecated

Update the customization of an AP.

path Parameters
serialNumber
required
string
Request Body schema: application/json
required
object (Wi-Fi_API_and_Model_Documentation_ExternalAntenna)

External antenna settings

Array of objects (Wi-Fi_API_and_Model_Documentation_ApLanPort)
ledEnabled
boolean
Default: false
poeOut
boolean
Default: false
useVenueSettings
boolean
Default: false

Responses

Request samples

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

Response samples

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

Import Venue APs

Import the venue's APs.

path Parameters
venueId
required
string

Venue ID.

Request Body schema:
required
description
string [ 0 .. 180 ] characters
object (Wi-Fi_API_and_Model_Documentation_DeviceGps)

Ap or Venue latitude and longitude

model
string [ 0 .. 64 ] characters
Default: "null"
name
required
string(?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$
serialNumber
required
string^[1-9][0-9]{11}$
tags
Array of strings [ 0 .. 24 ] items [ items [ 0 .. 24 ] characters ]

Responses

Request samples

Content type
{
  • "description": "string",
  • "deviceGps": {
    },
  • "model": "null",
  • "name": "string",
  • "serialNumber": "string",
  • "tags": [
    ]
}

Response samples

Content type
Example
{
  • "requestId": "string"
}

Get Import Venue APs Results

Get result for import venue APs from CSV file.

path Parameters
venueId
required
string

The ID of the venue.

query Parameters
operationRequestId
required
string

The request ID of the import venue APs operation.

Responses

Response samples

Content type
{
  • "downloadUrl": "string",
  • "errors": [
    ],
  • "fileErrorCount": 0,
  • "operationRequestId": "string"
}

Delete AP

Delete an AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

query Parameters
resetFirmware
boolean
Default: false

Reset AP firmware to Standalone image.

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get AP

Get the AP general info.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "description": "string",
  • "deviceGps": {
    },
  • "model": "null",
  • "name": "string",
  • "serialNumber": "string",
  • "tags": [
    ]
}

Trigger AP Action

Trigger AP action.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Request Body schema:
required
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
{
  • "action": "ping",
  • "targetHost": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Update AP

Update an AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Request Body schema:
required
description
string [ 0 .. 180 ] characters
object (Wi-Fi_API_and_Model_Documentation_DeviceGps)

Ap or Venue latitude and longitude

model
string [ 0 .. 64 ] characters
Default: "null"
name
required
string(?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$
serialNumber
required
string^[1-9][0-9]{11}$
tags
Array of strings [ 0 .. 24 ] items [ items [ 0 .. 24 ] characters ]

Responses

Request samples

Content type
{
  • "description": "string",
  • "deviceGps": {
    },
  • "model": "null",
  • "name": "string",
  • "serialNumber": "string",
  • "tags": [
    ]
}

Response samples

Content type
{
  • "requestId": "string"
}

Get AP Basic Service Set Coloring Settings

Get basic service set coloring settings of this AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP

Responses

Response samples

Content type
{
  • "bssColoringEnabled": false,
  • "useVenueSettings": false
}

Update AP Basic Service Set Coloring Settings

Update basic service set coloring settings of this AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP

Request Body schema:
required
bssColoringEnabled
boolean
Default: false
useVenueSettings
boolean
Default: false

Responses

Request samples

Content type
{
  • "bssColoringEnabled": false,
  • "useVenueSettings": false
}

Response samples

Content type
{
  • "requestId": "string"
}

Get AP Capabilities

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "allowCbandCountry": [
    ],
  • "allowDfsCountry": [
    ],
  • "canSupportCellular": false,
  • "canSupportLacp": false,
  • "canSupportPoeMode": false,
  • "canSupportPoeOut": false,
  • "capabilityScore": 0,
  • "externalAntenna": {
    },
  • "has160MHzChannelBandwidth": false,
  • "isOutdoor": false,
  • "lanPortPictureDownloadUrl": "string",
  • "lanPorts": [
    ],
  • "ledOn": false,
  • "lldpAdInterval": 0,
  • "lldpEnable": false,
  • "lldpHoldTime": 0,
  • "lldpMgmtEnable": false,
  • "maxChannelization24G": 0,
  • "maxChannelization5G": 0,
  • "maxChannelization6G": 0,
  • "model": "string",
  • "pictureDownloadUrl": "string",
  • "poeModeCapabilities": [
    ],
  • "primaryWanRecoveryTimer": 0,
  • "requireOneEnabledTrunkPort": false,
  • "simCardPrimaryApn": "string",
  • "simCardPrimaryCellularNetworkSelection": "string",
  • "simCardPrimaryEnabled": true,
  • "simCardPrimaryRoaming": true,
  • "simCardSecondaryApn": "string",
  • "simCardSecondaryCellularNetworkSelection": "string",
  • "simCardSecondaryEnabled": true,
  • "simCardSecondaryRoaming": true,
  • "support11AX": false,
  • "supportChannel144": false,
  • "supportDual5gMode": false,
  • "supportMesh": true,
  • "supportTriRadio": false,
  • "version": "string",
  • "wanConnection": "string"
}

Get AP Client Admission Control Settings

Get the client admission control settings of this AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "enable24G": false,
  • "enable50G": false,
  • "maxRadioLoad24G": 75,
  • "maxRadioLoad50G": 75,
  • "minClientCount24G": 10,
  • "minClientCount50G": 20,
  • "minClientThroughput24G": 0,
  • "minClientThroughput50G": 0,
  • "useVenueSettings": false
}

Update AP Client Admission Control Settings

Update the client admission control settings of this AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP

Request Body schema:
required
enable24G
boolean
Default: false
enable50G
boolean
Default: false
maxRadioLoad24G
integer <int32> [ 50 .. 100 ]
Default: 75
maxRadioLoad50G
integer <int32> [ 50 .. 100 ]
Default: 75
minClientCount24G
integer <int32> [ 0 .. 100 ]
Default: 10
minClientCount50G
integer <int32> [ 0 .. 100 ]
Default: 20
minClientThroughput24G
integer <int32> [ 0 .. 100 ]
Default: 0
minClientThroughput50G
integer <int32> [ 0 .. 100 ]
Default: 0
useVenueSettings
boolean
Default: false

Responses

Request samples

Content type
{
  • "enable24G": false,
  • "enable50G": false,
  • "maxRadioLoad24G": 75,
  • "maxRadioLoad50G": 75,
  • "minClientCount24G": 10,
  • "minClientCount50G": 20,
  • "minClientThroughput24G": 0,
  • "minClientThroughput50G": 0,
  • "useVenueSettings": false
}

Response samples

Content type
{
  • "requestId": "string"
}

Get AP DHCP Settings

Get DHCP settings by AP serial number.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "dhcpApRole": "PrimaryServer",
  • "serialNumber": "stringstring"
}

Get AP Directed Multicast Settings

Get directed multicast settings for this AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "networkEnabled": false,
  • "useVenueSettings": false,
  • "wiredEnabled": false,
  • "wirelessEnabled": false
}

Update AP Directed Multicast Settings

Update directed multicast settings of this AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Request Body schema:
required
networkEnabled
boolean
Default: false
useVenueSettings
boolean
Default: false
wiredEnabled
boolean
Default: false
wirelessEnabled
boolean
Default: false

Responses

Request samples

Content type
{
  • "networkEnabled": false,
  • "useVenueSettings": false,
  • "wiredEnabled": false,
  • "wirelessEnabled": false
}

Response samples

Content type
{
  • "requestId": "string"
}

Get AP External Antenna Settings

Get AP external antenna settings.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "externalAntenna": {
    },
  • "useVenueSettings": false
}

Update AP External Antenna Settings

Update external antenna settings of an AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Request Body schema:
required
object (Wi-Fi_API_and_Model_Documentation_ExternalAntenna)

External antenna settings

useVenueSettings
boolean
Default: false

Responses

Request samples

Content type
{
  • "externalAntenna": {
    },
  • "useVenueSettings": false
}

Response samples

Content type
{
  • "requestId": "string"
}

Get AP LAN-Ports

Get AP LAN-ports details.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "lanPorts": [
    ],
  • "poeMode": "Auto",
  • "poeOut": false,
  • "useVenueSettings": false
}

Update AP LAN-Ports

Update LAN-ports of an AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Request Body schema:
required
Array of objects (Wi-Fi_API_and_Model_Documentation_ApLanPort)
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
useVenueSettings
boolean
Default: false

Responses

Request samples

Content type
{
  • "lanPorts": [
    ],
  • "poeMode": "Auto",
  • "poeOut": false,
  • "useVenueSettings": false
}

Response samples

Content type
{
  • "requestId": "string"
}

Get AP LED

Get AP LED settings.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "ledEnabled": false,
  • "useVenueSettings": false
}

Update AP LED

Update LED of an AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Request Body schema:
required
ledEnabled
boolean
Default: false
useVenueSettings
boolean
Default: false

Responses

Request samples

Content type
{
  • "ledEnabled": false,
  • "useVenueSettings": false
}

Response samples

Content type
{
  • "requestId": "string"
}

Get the AP Log Info

Get the AP log info.

path Parameters
venueId
required
string

The ID of the venue.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "fileUrl": "string"
}

Get AP Mesh Settings

Get mesh settings for this AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "meshMode": "AUTO",
  • "uplinkMacAddresses": [
    ],
  • "uplinkMode": "SMART"
}

Update AP Mesh Settings

Update mesh settings of this AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Request Body schema:
required
meshMode
string
Default: "MeshModeEnum.AUTO"
Enum: "AUTO" "ROOT" "MESH" "DISABLED"
uplinkMacAddresses
Array of strings
uplinkMode
string
Default: "MeshUplinkModeEnum.SMART"
Enum: "SMART" "MANUAL"

Responses

Request samples

Content type
{
  • "meshMode": "AUTO",
  • "uplinkMacAddresses": [
    ],
  • "uplinkMode": "SMART"
}

Response samples

Content type
{
  • "requestId": "string"
}

Patch AP Neighbors

Ask AP to collect neighbors.

path Parameters
venueId
required
string

The ID of the venue.

serialNumber
required
string

The serial number of the AP.

Request Body schema:
required
status
required
string
Value: "CURRENT"
type
required
string
Enum: "RF_NEIGHBOR" "LLDP_NEIGHBOR"

Responses

Request samples

Content type
{
  • "status": "CURRENT",
  • "type": "RF_NEIGHBOR"
}

Response samples

Content type
{
  • "requestId": "string"
}

Query AP Neighbors

Query the AP's neighbors.

path Parameters
venueId
required
string

The ID of the venue.

serialNumber
required
string

The serial number of the AP.

Request Body schema:
required
Array of objects (Wi-Fi_API_and_Model_Documentation_ApNeighborQueryFilter)
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
sortField
string
sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
{
  • "filters": [
    ],
  • "page": 1,
  • "pageSize": 25,
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

Content type
{
  • "neighbors": [
    ],
  • "page": 0,
  • "totalCount": 0,
  • "totalPages": 0
}

Get AP Network Settings

Get network settings for this AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "gateway": "string",
  • "ip": "string",
  • "ipType": "DYNAMIC",
  • "netmask": "string",
  • "primaryDnsServer": "string",
  • "secondaryDnsServer": "string"
}

Update AP Network Settings

Update network settings of this AP.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Request Body schema:
required
gateway
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
ip
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
ipType
required
string
Enum: "DYNAMIC" "STATIC"
netmask
string^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128...
primaryDnsServer
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...
secondaryDnsServer
string^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][...

Responses

Request samples

Content type
{
  • "gateway": "string",
  • "ip": "string",
  • "ipType": "DYNAMIC",
  • "netmask": "string",
  • "primaryDnsServer": "string",
  • "secondaryDnsServer": "string"
}

Response samples

Content type
{
  • "requestId": "string"
}

Get AP Packets

Get the AP packet capture result.

path Parameters
venueId
required
string

The ID of the venue.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "errorMsg": "string",
  • "fileName": "string",
  • "fileUrl": "string",
  • "sessionId": "string",
  • "state": "IDLE"
}

Patch AP Packets

To start or stop the AP packet capture.

path Parameters
venueId
required
string

The ID of the venue.

serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json
required
action
string
Enum: "START" "STOP"
captureInterface
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})$|...
sessionId
string

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete AP Pictures

Delete the AP's pictures.

path Parameters
venueId
required
string

The ID of the venue.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get AP Pictures

Get the AP's pictures.

path Parameters
venueId
required
string

The ID of the venue.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "id": "null",
  • "name": "null",
  • "url": "string"
}

Update AP Pictures

Update the AP's pictures.

path Parameters
venueId
required
string

The ID of the venue.

serialNumber
required
string

The serial number of the AP.

Request Body schema:
file
required
string <binary>

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get AP Radio

Get AP radio details.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

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

Update AP Radio

Update an AP radio settings.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

The serial number of the AP.

Request Body schema:
required
object (Wi-Fi_API_and_Model_Documentation_ApRadio24GHzSettings)

AP radio customization for 2.4GHz.

object (Wi-Fi_API_and_Model_Documentation_ApRadio5GHzSettings)

AP radio customization for 5GHz.

object (Wi-Fi_API_and_Model_Documentation_ApRadio6GHzSettings)

AP radio customization for 6GHz.

object (Wi-Fi_API_and_Model_Documentation_ApRadioDual5GHzSettings)

AP radio customization for dual 5GHz radios.

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

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Get AP Available Channels

Get AP available channels.

path Parameters
venueId
required
string

Venue ID.

serialNumber
required
string

AP serialNumber

Responses

Response samples

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

Deactivate AP Floor Position

Deactivate the AP on a floor-plan and remove the position.

path Parameters
venueId
required
string

Venue ID.

floorplanId
required
string

Floor plan ID.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get AP Floor Position

Get the position of the AP on a floor-plan.

path Parameters
venueId
required
string

Venue ID.

floorplanId
required
string

Floor plan ID.

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "xPercent": 0,
  • "yPercent": 0
}

Activate AP Floor Position

Activate the AP on a floor-plan or update the position.

path Parameters
venueId
required
string

Venue ID.

floorplanId
required
string

Floor plan ID.

serialNumber
required
string

The serial number of the AP.

Request Body schema:
required
xPercent
number <float> [ 0 .. 100 ]
Default: 0
yPercent
number <float> [ 0 .. 100 ]
Default: 0

Responses

Request samples

Content type
{
  • "xPercent": 0,
  • "yPercent": 0
}

Response samples

Content type
{
  • "requestId": "string"
}

L3ACL Policy

Manage layer-3 ACL policy profiles.

Deactivate Layer-3 ACL Policy On Access Control Profile

Deactivate layer-3 ACL policy on access control profile.

path Parameters
accessControlProfileId
required
string

Access Control Profile ID

l3AclPolicyId
required
string

L3Acl Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Layer-3 ACL Policy On Access Control Profile

Activate layer-3 ACL policy on access control profile.

path Parameters
accessControlProfileId
required
string

Access Control Profile ID

l3AclPolicyId
required
string

L3Acl Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Delete Layer-3 ACL Policies Deprecated

Delete layer-3 ACL policies.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get Layer-3 ACL Policies Deprecated

Get layer-3 ACL policy collection.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Layer-3 ACL

Add layer-3 ACL by policy. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

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

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Layer-3 ACL

Delete layer-3 ACL by policy id. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
l3AclPolicyId
required
string

L3Acl Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Layer-3 ACL

Get layer-3 ACL by policy id.

path Parameters
l3AclPolicyId
required
string

L3Acl Policy ID

Responses

Response samples

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

Update Layer-3 ACL

Update layer-3 ACL by policy id. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
l3AclPolicyId
required
string

L3Acl Policy ID

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

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate Layer-3 ACL Policy On Wi-Fi Network

Deactivate layer-3 ACL policy on Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

l3AclPolicyId
required
string

L3Acl Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Layer-3 ACL Policy On Wi-Fi Network

Activate layer-3 ACL policy on Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

l3AclPolicyId
required
string

L3Acl Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Syslog Server Profile

Manage Syslog server profiles.

Delete Syslog Server Profiles Deprecated

Delete a list of syslog server profiles.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get Syslog Server Profiles Deprecated

Get the syslog server profiles.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Syslog Server Profile

Create a new syslog server profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
required
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 (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
required
object (Wi-Fi_API_and_Model_Documentation_SyslogServer)

Syslog server

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

Syslog server

Array of objects (Wi-Fi_API_and_Model_Documentation_IdAndName)

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Delete Syslog Server Profile

Delete a syslog server profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
syslogServerProfileId
required
string

Syslog Server Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Syslog Server Profile

Get Syslog Server Profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
syslogServerProfileId
required
string

Syslog Server Profile ID

Responses

Response samples

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

Update Syslog Server Profile

Update a syslog server profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
syslogServerProfileId
required
string

Syslog Server Profile ID

Request Body schema:
required
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 (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
required
object (Wi-Fi_API_and_Model_Documentation_SyslogServer)

Syslog server

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

Syslog server

Array of objects (Wi-Fi_API_and_Model_Documentation_IdAndName)

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate Syslog Server Profile On Venue

Use this API command to delete a relationship between syslog server profile and venue.

path Parameters
venueId
required
string

Venue ID

syslogServerProfileId
required
string

Syslog server profile identity

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Syslog Server Profile On Venue

Use this API command to build a relationship between syslog server profile and venue.

path Parameters
venueId
required
string

Venue ID

syslogServerProfileId
required
string

Syslog server profile identity

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Wi-Fi Network

Manage Wi-Fi network profiles.

Delete Networks Deprecated

Delete a list of networks.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get Networks Deprecated

Get the network list.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Network Deprecated

Create a new network.

Request Body schema: application/json
required
One of
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
type
required
string
accountingRadiusId
string
authRadiusId
string
description
string [ 0 .. 255 ] characters
enableAccountingProxy
boolean
Default: false
enableAuthProxy
boolean
Default: false
required
object (Wi-Fi_API_and_Model_Documentation_AAAWlan)

WLAN

Responses

Request samples

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

Response samples

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

Get Default Rules for QoS Map Set Deprecated

Get default rules for QoS map set.

Responses

Response samples

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

Get External WISPr Providers Deprecated

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 Deprecated

Delete a network.

path Parameters
networkId
required
string

Network ID

Responses

Response samples

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

Get Network Deprecated

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",
  • "tenantId": "string",
  • "type": "Wi-Fi_API_and_Model_Documentation_AAANetwork",
  • "accountingRadiusId": "string",
  • "authRadiusId": "string",
  • "description": "string",
  • "enableAccountingProxy": false,
  • "enableAuthProxy": false,
  • "venues": [
    ],
  • "wlan": {
    }
}

Update Network Deprecated

Update this network, including nested details.

path Parameters
networkId
required
string

Network ID

Request Body schema: application/json
required
One of
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
type
required
string
accountingRadiusId
string
authRadiusId
string
description
string [ 0 .. 255 ] characters
enableAccountingProxy
boolean
Default: false
enableAuthProxy
boolean
Default: false
required
object (Wi-Fi_API_and_Model_Documentation_AAAWlan)

WLAN

Responses

Request samples

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

Response samples

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

Delete Network Activation

Use this API to delete a relationship between Wi-Fi network and venue.

path Parameters
venueId
required
string

Venue ID

wifiNetworkId
required
string

Wi-Fi Network ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Wi-Fi Network On Venue

Use this API to build a relationship between Wi-Fi network and venue.

path Parameters
venueId
required
string

Venue ID

wifiNetworkId
required
string

Wi-Fi Network ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Venue Wi-Fi Network Settings

Get Wi-Fi network settings on this venue.

path Parameters
venueId
required
string

Venue ID

wifiNetworkId
required
string

Wi-Fi Network ID

Responses

Response samples

Content type
{
  • "allApGroupsRadioTypes": [
    ],
  • "allApGroupsVlanId": 1,
  • "isAllApGroups": true,
  • "scheduler": {
    }
}

Update Venue Wi-Fi Network Settings

Update Wi-Fi network settings on this venue.

path Parameters
venueId
required
string

Venue ID

wifiNetworkId
required
string

Wi-Fi Network ID

Request Body schema:
required
allApGroupsRadioTypes
Array of strings
Items Enum: "2.4-GHz" "5-GHz" "6-GHz"
allApGroupsVlanId
integer <int32> [ 1 .. 4094 ]
isAllApGroups
boolean
Default: true
object (Wi-Fi_API_and_Model_Documentation_NetworkVenueScheduler)

Network-Venue scheduler

Responses

Request samples

Content type
{
  • "allApGroupsRadioTypes": [
    ],
  • "allApGroupsVlanId": 1,
  • "isAllApGroups": true,
  • "scheduler": {
    }
}

Response samples

Content type
{
  • "requestId": "string"
}

Create Wi-Fi Network

Create a new Wi-Fi network.

Request Body schema:
required
One of
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
type
required
string
description
string [ 0 .. 255 ] characters
required
object (Wi-Fi_API_and_Model_Documentation_AAAWifiWlan)

AAA Wi-Fi WLAN

Responses

Request samples

Content type
Example
{
  • "name": "string",
  • "type": "string",
  • "description": "string",
  • "wlan": {
    }
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Get Default Options for QoS Map Set

Get default options for QoS map set.

Responses

Response samples

Content type
{
  • "rules": [
    ]
}

Get Wi-Fi Recovery Network Passphrase Settings

Get the passphrase settings for the Wi-Fi recovery network.

Responses

Response samples

Content type
{
  • "passphrase": "string"
}

Update Wi-Fi Recovery Network Passphrase Settings

Update the passphrase settings for the Wi-Fi recovery network.

Request Body schema:
required
passphrase
string^([0-9]{4}){4}$

Responses

Request samples

Content type
{
  • "passphrase": "string"
}

Response samples

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

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
{
  • "wisprProviders": [
    ]
}

Delete Wi-Fi Network

Delete a Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Wi-Fi Network

Get the Wi-Fi network details.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

Responses

Response samples

Content type
Example
{
  • "id": "string",
  • "name": "string",
  • "type": "Wi-Fi_API_and_Model_Documentation_AAAWifiNetwork",
  • "description": "string",
  • "wlan": {
    }
}

Update Wi-Fi Network

Update this Wi-Fi network, including nested details.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

Request Body schema:
required
One of
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
type
required
string
description
string [ 0 .. 255 ] characters
required
object (Wi-Fi_API_and_Model_Documentation_AAAWifiWlan)

AAA Wi-Fi WLAN

Responses

Request samples

Content type
Example
{
  • "name": "string",
  • "type": "string",
  • "description": "string",
  • "wlan": {
    }
}

Response samples

Content type
{
  • "requestId": "string"
}

Validate X509 Certificates Deprecated

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

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

X509 certificate

Responses

Request samples

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

Response samples

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

Application Policy

Manage application policy profiles.

Deactivate Application Policy On Access Control Profile

Use this API command to deactivate an application policy on an access control profile.

path Parameters
accessControlProfileId
required
string
applicationPolicyId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Application Policy On Access Control Profile

Use this API command to activate an application policy on an access control profile.

path Parameters
accessControlProfileId
required
string
applicationPolicyId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Delete Application Policies Deprecated

Use this API command to delete an application policy list.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get Application Policies Deprecated

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. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
required
description
string [ 0 .. 64 ] characters
name
required
string [ 2 .. 32 ] characters
Array of objects (Wi-Fi_API_and_Model_Documentation_ApplicationPolicyRule) [ 1 .. 128 ] items

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Application Policy

Use this API command to delete application policy.

path Parameters
applicationPolicyId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Application Policy

Use this API command to get the application policy details. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
applicationPolicyId
required
string

Responses

Response samples

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

Update Application Policy

Use this API command to update application policy. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
applicationPolicyId
required
string
Request Body schema:
required
description
string [ 0 .. 64 ] characters
name
required
string [ 2 .. 32 ] characters
Array of objects (Wi-Fi_API_and_Model_Documentation_ApplicationPolicyRule) [ 1 .. 128 ] items

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate Application Policy On Wifi Network

Use this API command to deactivate an application policy on a Wi-Fi network.

path Parameters
wifiNetworkId
required
string
applicationPolicyId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Application Policy On Wifi Network

Use this API command to activate an application policy on a Wi-Fi network.

path Parameters
wifiNetworkId
required
string
applicationPolicyId
required
string

Responses

Response samples

Content type
{
  • "requestId": "string"
}

AP Group

Manage AP-Groups.

Delete AP-Groups Deprecated

Delete a list of AP-groups.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get AP-Groups Deprecated

Get the AP-group list.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete AP-Group Deprecated

Delete an AP-group.

path Parameters
apGroupId
required
string

AP-group ID

Responses

Response samples

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

Get AP-Group Deprecated

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 Deprecated

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
required
Array of objects (Wi-Fi_API_and_Model_Documentation_ApSerialNumber)
description
string [ 2 .. 180 ] characters
name
required
string(?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$
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 Deprecated

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:
required
Array of objects (Wi-Fi_API_and_Model_Documentation_ApSerialNumber)
description
string [ 2 .. 180 ] characters
name
required
string(?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$
venueId
string
Deprecated

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Delete AP Group

Delete an AP group.

path Parameters
venueId
required
string

Venue ID

apGroupId
required
string

AP Group ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get AP Group

Get the AP group details.

path Parameters
venueId
required
string

Venue ID

apGroupId
required
string

AP Group ID

Responses

Response samples

Content type
{
  • "apSerialNumbers": [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string"
}

Update AP Group

Update an AP group.

path Parameters
venueId
required
string

Venue ID

apGroupId
required
string

AP Group ID

Request Body schema:
required
apSerialNumbers
Array of strings
description
string [ 2 .. 180 ] characters
name
required
string(?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$

Responses

Request samples

Content type
{
  • "apSerialNumbers": [
    ],
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate AP Group On Wi-Fi Network

Deactivate the AP group and remove the settings on the Wi-Fi network with the venue.

path Parameters
venueId
required
string

Venue ID

wifiNetworkId
required
string

Wi-Fi Network ID

apGroupId
required
string

AP Group ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate AP Group On Wi-Fi Network

Activate the AP group on the Wi-Fi network with the venue.

path Parameters
venueId
required
string

Venue ID

wifiNetworkId
required
string

Wi-Fi Network ID

apGroupId
required
string

AP Group ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get AP Group Settings On Wi-Fi Network

Get the activated AP group settings on the Wi-Fi network with the venue.

path Parameters
venueId
required
string

Venue ID

wifiNetworkId
required
string

Wi-Fi Network ID

apGroupId
required
string

AP Group ID

Responses

Response samples

Content type
{
  • "radioTypes": [
    ],
  • "vlanId": 1
}

Update AP Group Settings On Wi-Fi Network

Update the activated AP group settings on the Wi-Fi network with the venue.

path Parameters
venueId
required
string

Venue ID

wifiNetworkId
required
string

Wi-Fi Network ID

apGroupId
required
string

AP Group ID

Request Body schema:
required
radioTypes
Array of strings
Items Enum: "2.4-GHz" "5-GHz" "6-GHz"
vlanId
integer <int32> [ 1 .. 4094 ]

Responses

Request samples

Content type
{
  • "radioTypes": [
    ],
  • "vlanId": 1
}

Response samples

Content type
{
  • "requestId": "string"
}

Client

Manage client connections.

Clients Control Deprecated

Control a list of clients.

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

Responses

Request samples

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

Response samples

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

Patch AP Client

Patch the AP's client.

path Parameters
venueId
required
string

The ID of the venue.

serialNumber
required
string

The serial number of the AP.

clientMacAddress
required
string

The mac address of the client.

Request Body schema:
required
status
required
string
Value: "DISCONNECTED"

Responses

Request samples

Content type
{
  • "status": "DISCONNECTED"
}

Response samples

Content type
{
  • "requestId": "string"
}

DHCP Configuration Service Profile

Manage DHCP configuration service profiles.

Delete DHCP Configuration Service Profiles Deprecated

Delete a list of DHCP configuration service profiles. Use DELETE:/venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId} instead.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get DHCP Configuration Service Profiles Deprecated

Get the DHCP configuration service profiles.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create DHCP Configuration Service Profile

Create a new DHCP configuration service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
required
dhcpMode
string
Default: "DhcpModeEnum.EnableOnEachAPs"
Enum: "EnableOnEachAPs" "EnableOnMultipleAPs" "EnableOnHierarchicalAPs"
required
Array of objects (Wi-Fi_API_and_Model_Documentation_DhcpPool) [ 1 .. 4 ] items
serviceName
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Content type
{
  • "dhcpMode": "EnableOnEachAPs",
  • "dhcpPools": [
    ],
  • "serviceName": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete DHCP Configuration Service Profile

Delete a DHCP configuration service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
dhcpConfigServiceProfileId
required
string

DHCP Config Service Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get DHCP Configuration Service Profile

Get the DHCP configuration service profile details. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
dhcpConfigServiceProfileId
required
string

DHCP Config Service Profile ID

Responses

Response samples

Content type
{
  • "dhcpMode": "EnableOnEachAPs",
  • "dhcpPools": [
    ],
  • "id": "string",
  • "serviceName": "string",
  • "usage": [
    ],
  • "venueIds": [
    ]
}

Update DHCP Configuration Service Profile

Update a DHCP configuration service profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
dhcpConfigServiceProfileId
required
string

DHCP Config Service Profile ID

Request Body schema:
required
dhcpMode
string
Default: "DhcpModeEnum.EnableOnEachAPs"
Enum: "EnableOnEachAPs" "EnableOnMultipleAPs" "EnableOnHierarchicalAPs"
required
Array of objects (Wi-Fi_API_and_Model_Documentation_DhcpPool) [ 1 .. 4 ] items
serviceName
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Content type
{
  • "dhcpMode": "EnableOnEachAPs",
  • "dhcpPools": [
    ],
  • "serviceName": "string"
}

Response samples

Content type
{
  • "requestId": "string"
}

Get AP DHCP Client Leases

Get a list of DHCP client leases of the AP.

path Parameters
venueId
required
string

Venue ID

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "wifiDhcpClientLeases": [
    ]
}

Get DHCP Pools Usage in This AP

Get DHCP pools usage in this AP.

path Parameters
venueId
required
string

Venue ID

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "wifiDhcpPoolUsages": [
    ]
}

Deactivate DHCP Configuration Service Profile On This Venue

Deactivate DHCP configuration service profile on this venue.

path Parameters
venueId
required
string

Venue ID

dhcpConfigServiceProfileId
required
string

DHCP Config Service Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get DHCP Service Profile Settings of This Venue

Get DHCP service profile settings of this venue.

path Parameters
venueId
required
string

Venue ID

dhcpConfigServiceProfileId
required
string

DHCP Config Service Profile ID

Responses

Response samples

Content type
{
  • "activeDhcpPoolNames": [
    ],
  • "dhcpServiceAps": [
    ],
  • "wanPortSelectionMode": "Dynamic"
}

Activate DHCP Configuration Service Profile On This Venue and Update Settings

Activate DHCP configuration service profile on this venue and update settings.

path Parameters
venueId
required
string

Venue ID

dhcpConfigServiceProfileId
required
string

DHCP Config Service Profile ID

Request Body schema:
required
activeDhcpPoolNames
Array of strings
Array of objects (Wi-Fi_API_and_Model_Documentation_DhcpServiceAp)
wanPortSelectionMode
string
Default: "DhcpWanPortSelectionModeEnum.Dynamic"
Enum: "Dynamic" "Manual"

Responses

Request samples

Content type
{
  • "activeDhcpPoolNames": [
    ],
  • "dhcpServiceAps": [
    ],
  • "wanPortSelectionMode": "Dynamic"
}

Response samples

Content type
{
  • "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
{
  • "wifiDhcpClientLeases": [
    ]
}

Get DHCP Pools Usage in Venue

Get DHCP pools usage in this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "wifiDhcpPoolUsages": [
    ]
}

AP SNMP Agent Profile

Manage AP SNMP policy profiles.

Delete AP SNMP Agent Profiles Deprecated

Delete a list of AP SNMP agent profiles.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get AP SNMP Agent Profiles Deprecated

Get the AP SNMP agent profiles.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create AP SNMP Agent Profile Deprecated

Create a new AP SNMP agent profile.

Request Body schema: application/json
required
policyName
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
Array of objects (Wi-Fi_API_and_Model_Documentation_ApSnmpV2Agent) [ 0 .. 2 ] items
Array of objects (Wi-Fi_API_and_Model_Documentation_ApSnmpV3Agent) [ 0 .. 2 ] items

Responses

Request samples

Content type
application/json
{
  • "policyName": "string",
  • "snmpV2Agents": [
    ],
  • "snmpV3Agents": [
    ]
}

Response samples

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

Delete AP SNMP Agent Profile Deprecated

Delete a AP SNMP agent profile.

path Parameters
apSnmpProfileId
required
string

AP SNMP Agent Profile ID

Responses

Response samples

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

Get AP SNMP Profile Deprecated

Get the details for this AP SNMP profile.

path Parameters
apSnmpProfileId
required
string

AP SNMP Agent Profile ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "policyName": "string",
  • "snmpV2Agents": [
    ],
  • "snmpV3Agents": [
    ],
  • "tenantId": "string"
}

Update AP SNMP Agent Profile Deprecated

Update a AP SNMP agent profile.

path Parameters
apSnmpProfileId
required
string

AP SNMP Agent Profile ID

Request Body schema: application/json
required
policyName
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
Array of objects (Wi-Fi_API_and_Model_Documentation_ApSnmpV2Agent) [ 0 .. 2 ] items
Array of objects (Wi-Fi_API_and_Model_Documentation_ApSnmpV3Agent) [ 0 .. 2 ] items

Responses

Request samples

Content type
application/json
{
  • "policyName": "string",
  • "snmpV2Agents": [
    ],
  • "snmpV3Agents": [
    ]
}

Response samples

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

Get AP SNMP Agent Profile AP Usage Deprecated

Get a list of APs of the AP SNMP agent profile.

path Parameters
apSnmpProfileId
required
string

AP SNMP Agent Profile ID

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

Search by AP name or venue name.

sortField
string

AP name or venue name only.

sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

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

Response samples

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

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
[
  • {
    }
]

Get AP Model Capabilities

Responses

Response samples

Content type
{
  • "apModels": [
    ]
}

Get Available LTE Bands Deprecated

Get available LTE bands for each region.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Venues Wi-Fi Settings Deprecated

Get the venue list of Wi-Fi details.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Venue Basic Service Set Coloring Settings

Get basic service set coloring settings of this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "bssColoringEnabled": true
}

Update Venue Basic Service Set Coloring Settings

Update basic service set coloring settings of this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema:
required
bssColoringEnabled
boolean
Default: true

Responses

Request samples

Content type
{
  • "bssColoringEnabled": true
}

Response samples

Content type
{
  • "requestId": "string"
}

Get Venue AP-Model Cellular

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

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "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

Venue ID

Request Body schema:
required
model
string [ 0 .. 64 ] characters
object (Wi-Fi_API_and_Model_Documentation_SimSettings)

SIM setting object.

primaryWanRecoveryTimer
required
integer <int32> [ 10 .. 300 ]
object (Wi-Fi_API_and_Model_Documentation_SimSettings)

SIM setting object.

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

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Get Venue Client Admission Control Settings

Get this venue's client admission control settings.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "enable24G": false,
  • "enable50G": false,
  • "maxRadioLoad24G": 75,
  • "maxRadioLoad50G": 75,
  • "minClientCount24G": 10,
  • "minClientCount50G": 20,
  • "minClientThroughput24G": 0,
  • "minClientThroughput50G": 0
}

Update Venue Client Admission Control Settings

Update this venue's client admission control settings.

path Parameters
venueId
required
string

Venue ID

Request Body schema:
required
enable24G
boolean
Default: false
enable50G
boolean
Default: false
maxRadioLoad24G
integer <int32> [ 50 .. 100 ]
Default: 75
maxRadioLoad50G
integer <int32> [ 50 .. 100 ]
Default: 75
minClientCount24G
integer <int32> [ 0 .. 100 ]
Default: 10
minClientCount50G
integer <int32> [ 0 .. 100 ]
Default: 20
minClientThroughput24G
integer <int32> [ 0 .. 100 ]
Default: 0
minClientThroughput50G
integer <int32> [ 0 .. 100 ]
Default: 0

Responses

Request samples

Content type
{
  • "enable24G": false,
  • "enable50G": false,
  • "maxRadioLoad24G": 75,
  • "maxRadioLoad50G": 75,
  • "minClientCount24G": 10,
  • "minClientCount50G": 20,
  • "minClientThroughput24G": 0,
  • "minClientThroughput50G": 0
}

Response samples

Content type
{
  • "requestId": "string"
}

Get Venue Directed Multicast Settings

Get directed multicast settings for this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

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

Update UpdateVenue Directed Multicast Settings

Update directed multicast settings of this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema:
required
networkEnabled
boolean
Default: true
wiredEnabled
boolean
Default: true
wirelessEnabled
boolean
Default: true

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Get Venue DoS Protection

Get DoS protection of this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "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:
required
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
{
  • "blockingPeriod": 60,
  • "checkPeriod": 30,
  • "enabled": false,
  • "failThreshold": 5
}

Response samples

Content type
{
  • "requestId": "string"
}

Get Venue Load Balancing Settings

Get load balancing settings for this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "bandBalancingClientPercent24G": 25,
  • "bandBalancingEnabled": true,
  • "enabled": false,
  • "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
  • "steeringMode": "BASIC"
}

Update Venue Load Balancing Settings

Update venue load balancing settings of this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema:
required
bandBalancingClientPercent24G
integer <int32> [ 0 .. 100 ]
Default: 25
bandBalancingEnabled
boolean
Default: true
enabled
boolean
Default: false
loadBalancingMethod
string
Default: "LoadBalancingMethodEnum.BASED_ON_CLIENT_COUNT"
Enum: "BASED_ON_CLIENT_COUNT" "BASED_ON_CAPACITY"
steeringMode
string
Default: "SteeringModeEnum.BASIC"
Enum: "BASIC" "PROACTIVE" "STRICT"

Responses

Request samples

Content type
{
  • "bandBalancingClientPercent24G": 25,
  • "bandBalancingEnabled": true,
  • "enabled": false,
  • "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
  • "steeringMode": "BASIC"
}

Response samples

Content type
{
  • "requestId": "string"
}

Get Mesh Settings

Get the venue mesh settings.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "enabled": false,
  • "passphrase": "string",
  • "radioType": "2.4-GHz",
  • "ssid": "string"
}

Update Mesh

Enable/disable the venue mesh.

path Parameters
venueId
required
string

Venue ID

Request Body schema:
required
enabled
boolean
Default: false
passphrase
string(^[!-~]([ -~]){6,61}[!-~]$)|(^([0-9a-fA-F]){6...
radioType
string
Default: "MeshRadioTypeEnum._5_GHz"
Enum: "2.4-GHz" "5-GHz"
ssid
string(^(?!.*(\$\(|`))(([!-~]([ -~]){0,30}[!-~]$)|(...

Responses

Request samples

Content type
{
  • "enabled": false,
  • "passphrase": "string",
  • "radioType": "2.4-GHz",
  • "ssid": "string"
}

Response samples

Content type
{
  • "requestId": "string"
}

Get Venue AP-Model Capabilities

Get AP model capabilities of the venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "apModels": [
    ]
}

Get Venue AP Model External Antenna Settings

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

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
[
  • {
    }
]

Update Venue AP Model External Antenna Settings

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

path Parameters
venueId
required
string

Venue ID

Request Body schema:
required
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
[
  • {
    }
]

Response samples

Content type
{
  • "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
[
  • {
    }
]

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:
required
Array
Array of objects (Wi-Fi_API_and_Model_Documentation_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
[
  • {
    }
]

Response samples

Content type
{
  • "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
[
  • {
    }
]

Update Venue LED

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

path Parameters
venueId
required
string

Venue ID

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

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "requestId": "string"
}

Get Venue Multicast DNS Fencing Settings

Get multicast DNS fencing settings of the APs in this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "enabled": false,
  • "rules": [
    ]
}

Update Venue Multicast DNS Fencing Settings

Update multicast DNS fencing settings of the APs in this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema:
required
enabled
boolean
Default: false
Array of objects (Wi-Fi_API_and_Model_Documentation_MulticastDnsFencingRule)

Responses

Request samples

Content type
{
  • "enabled": false,
  • "rules": [
    ]
}

Response samples

Content type
{
  • "requestId": "string"
}

Reset Venue Radio

Reset venue radio to default values.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "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
{
  • "radioParams24G": {
    },
  • "radioParams50G": {
    },
  • "radioParams6G": {
    },
  • "radioParamsDual5G": {
    }
}

Update Venue Radio

Update the venue radio.

path Parameters
venueId
required
string

Venue ID

Request Body schema:
required
object (Wi-Fi_API_and_Model_Documentation_VenueApRadio24GHzSettings)

Customized settings for 2.4-GHz radio.

object (Wi-Fi_API_and_Model_Documentation_VenueApRadio5GHzSettings)

Customized settings for 5-GHz radio.

object (Wi-Fi_API_and_Model_Documentation_VenueApRadio6GHzSettings)

Customized settings for 6-GHz radio.

object (Wi-Fi_API_and_Model_Documentation_VenueApRadioDual5GHzSettings)

Customized settings for lower/upper 5-GHz radios.

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Get Venue RADIUS Options Settings

Get this venue's RADIUS options settings.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
{
  • "calledStationIdType": "BSSID",
  • "nasIdDelimiter": "DASH",
  • "nasIdType": "USER",
  • "nasMaxRetry": 2,
  • "nasReconnectPrimaryMin": 5,
  • "nasRequestTimeoutSec": 3,
  • "overrideEnabled": false,
  • "singleSessionIdAccounting": false,
  • "userDefinedNasId": "string"
}

Update Venue RADIUS Options Settings

Update this venue's RADIUS options settings.

path Parameters
venueId
required
string

Venue ID

Request Body schema:
required
calledStationIdType
string
Default: "CalledStationIdTypeEnum.BSSID"
Enum: "BSSID" "AP_MAC" "NONE" "AP_GROUP"
nasIdDelimiter
string
Default: "NasIdDelimiterEnum.DASH"
Enum: "DASH" "COLON"
nasIdType
string
Default: "NasIdTypeEnum.BSSID"
Enum: "USER" "BSSID" "AP_MAC" "VENUE_NAME"
nasMaxRetry
integer <int32> [ 2 .. 10 ]
Default: 2
nasReconnectPrimaryMin
integer <int32> [ 1 .. 300 ]
Default: 5
nasRequestTimeoutSec
integer <int32> [ 2 .. 20 ]
Default: 3
overrideEnabled
boolean
Default: false
singleSessionIdAccounting
boolean
Default: false
userDefinedNasId
string [ 2 .. 64 ] characters ^((?!`|\$\()[ -~]){2,64}$

Responses

Request samples

Content type
{
  • "calledStationIdType": "BSSID",
  • "nasIdDelimiter": "DASH",
  • "nasIdType": "USER",
  • "nasMaxRetry": 2,
  • "nasReconnectPrimaryMin": 5,
  • "nasRequestTimeoutSec": 3,
  • "overrideEnabled": false,
  • "singleSessionIdAccounting": false,
  • "userDefinedNasId": "string"
}

Response samples

Content type
{
  • "requestId": "string"
}

Get Venue AP-Model Capabilities Deprecated

Get AP model capabilities of the venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

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

Get Venue Basic Service Set Coloring Settings Deprecated

Get basic service set coloring settings of this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "bssColoringEnabled": true
}

Update Venue Basic Service Set Coloring Settings Deprecated

Update basic service set coloring settings of this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
required
bssColoringEnabled
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "bssColoringEnabled": true
}

Response samples

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

Get Venue AP-Model Cellular Deprecated

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 Deprecated

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

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

SIM setting object.

primaryWanRecoveryTimer
required
integer <int32> [ 10 .. 300 ]
object (Wi-Fi_API_and_Model_Documentation_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 Deprecated

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 Client Admission Control Settings Deprecated

Get this venue's client admission control settings.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "enable24G": false,
  • "enable50G": false,
  • "maxRadioLoad24G": 75,
  • "maxRadioLoad50G": 75,
  • "minClientCount24G": 10,
  • "minClientCount50G": 20,
  • "minClientThroughput24G": 0,
  • "minClientThroughput50G": 0
}

Update Venue Client Admission Control Settings Deprecated

Update this venue's client admission control settings.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
required
enable24G
boolean
Default: false
enable50G
boolean
Default: false
maxRadioLoad24G
integer <int32> [ 50 .. 100 ]
Default: 75
maxRadioLoad50G
integer <int32> [ 50 .. 100 ]
Default: 75
minClientCount24G
integer <int32> [ 0 .. 100 ]
Default: 10
minClientCount50G
integer <int32> [ 0 .. 100 ]
Default: 20
minClientThroughput24G
integer <int32> [ 0 .. 100 ]
Default: 0
minClientThroughput50G
integer <int32> [ 0 .. 100 ]
Default: 0

Responses

Request samples

Content type
application/json
{
  • "enable24G": false,
  • "enable50G": false,
  • "maxRadioLoad24G": 75,
  • "maxRadioLoad50G": 75,
  • "minClientCount24G": 10,
  • "minClientCount50G": 20,
  • "minClientThroughput24G": 0,
  • "minClientThroughput50G": 0
}

Response samples

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

Get DHCP Service Profile Settings of This Venue Deprecated

Get DHCP service profile settings of this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "dhcpServiceAps": [
    ],
  • "enabled": false,
  • "id": "string",
  • "serviceProfileId": "string",
  • "wanPortSelectionMode": "Dynamic"
}

Update DHCP Service Profile Settings of This Venue Deprecated

Update DHCP service profile settings of this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
required
Array of objects (Wi-Fi_API_and_Model_Documentation_DhcpServiceAp)
enabled
boolean
Default: false
serviceProfileId
string
wanPortSelectionMode
string
Default: "DhcpWanPortSelectionModeEnum.Dynamic"
Enum: "Dynamic" "Manual"

Responses

Request samples

Content type
application/json
{
  • "dhcpServiceAps": [
    ],
  • "enabled": false,
  • "serviceProfileId": "string",
  • "wanPortSelectionMode": "Dynamic"
}

Response samples

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

Get Venue DHCP Leases Deprecated

Get a list of DHCP leases of the venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get DHCP Pools Usage in Venue Deprecated

Get DHCP pool data and usage in this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deactivate DHCP Pools in Venue Deprecated

Deactivate DHCP pools in venue.

path Parameters
venueId
required
string
dhcpPoolId
required
string

Responses

Response samples

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

Activate DHCP Pools in Venue Deprecated

Activate DHCP pools in venue.

path Parameters
venueId
required
string
dhcpPoolId
required
string

Responses

Response samples

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

Get Venue Directed Multicast Settings Deprecated

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 Deprecated

Update venue directed multicast settings of this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
required
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 Deprecated

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 Deprecated

Update DoS protection of this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
required
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 Deprecated

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 Deprecated

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

path Parameters
venueId
required
string
Request Body schema: application/json
required
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 Client Isolation Allowlists Deprecated

Get a list of client isolation allowlists of the venue.

path Parameters
venueId
required
string

Venue ID

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

Support name only

sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "pageSize": 25,
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

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

Get Venue LAN-Ports Deprecated

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 Deprecated

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
required
Array
Array of objects (Wi-Fi_API_and_Model_Documentation_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 Deprecated

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 Deprecated

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

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
required
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"
}

Get Venue Load Balancing Settings Deprecated

Get load balancing settings for this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "bandBalancingClientPercent24G": 25,
  • "bandBalancingEnabled": true,
  • "enabled": false,
  • "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
  • "steeringMode": "BASIC"
}

Update Venue Load Balancing Settings Deprecated

Update venue load balancing settings of this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
required
bandBalancingClientPercent24G
integer <int32> [ 0 .. 100 ]
Default: 25
bandBalancingEnabled
boolean
Default: true
enabled
boolean
Default: false
loadBalancingMethod
string
Default: "LoadBalancingMethodEnum.BASED_ON_CLIENT_COUNT"
Enum: "BASED_ON_CLIENT_COUNT" "BASED_ON_CAPACITY"
steeringMode
string
Default: "SteeringModeEnum.BASIC"
Enum: "BASIC" "PROACTIVE" "STRICT"

Responses

Request samples

Content type
application/json
{
  • "bandBalancingClientPercent24G": 25,
  • "bandBalancingEnabled": true,
  • "enabled": false,
  • "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
  • "steeringMode": "BASIC"
}

Response samples

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

Get Multicast DNS Fencing Settings Deprecated

Get this venue's multicast DNS fencing settings.

path Parameters
venueId
required
string

Responses

Response samples

Content type
application/json
{
  • "enabled": false,
  • "services": [
    ]
}

Update Multicast DNS Fencing Settings Deprecated

Update this venue's multicast DNS fencing settings.

path Parameters
venueId
required
string
Request Body schema: application/json
required
enabled
boolean
Default: false
Array of objects (Wi-Fi_API_and_Model_Documentation_MdnsFencing)

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "services": [
    ]
}

Response samples

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

Update Mesh Deprecated

Enable/disable the venue mesh.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
required
enabled
boolean
Default: false
passphrase
string(^[!-~]([ -~]){6,61}[!-~]$)|(^([0-9a-fA-F]){6...
radioType
string
Default: "MeshRadioTypeEnum._5_GHz"
Enum: "2.4-GHz" "5-GHz"
ssid
string(^(?!.*(\$\(|`))(([!-~]([ -~]){0,30}[!-~]$)|(...

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "passphrase": "string",
  • "radioType": "2.4-GHz",
  • "ssid": "string"
}

Response samples

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

Reset Venue Radio Deprecated

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 Deprecated

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 Deprecated

Update the venue radio.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
required
object (Wi-Fi_API_and_Model_Documentation_RadioParams24G)

Radio customization for 2.4GHz.

object (Wi-Fi_API_and_Model_Documentation_RadioParams50G)

Radio customization for 5GHz.

object (Wi-Fi_API_and_Model_Documentation_RadioParams6G)

Radio customization for 6GHz.

object (Wi-Fi_API_and_Model_Documentation_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 RADIUS Options Settings Deprecated

Get this venue's RADIUS options settings.

path Parameters
venueId
required
string

Responses

Response samples

Content type
application/json
{
  • "calledStationIdType": "BSSID",
  • "nasIdDelimiter": "DASH",
  • "nasIdType": "USER",
  • "nasMaxRetry": 2,
  • "nasReconnectPrimaryMin": 5,
  • "nasRequestTimeoutSec": 3,
  • "overrideEnabled": false,
  • "singleSessionIdAccounting": false,
  • "userDefinedNasId": "string"
}

Update Venue RADIUS Options Settings Deprecated

Update this venue's RADIUS options settings.

path Parameters
venueId
required
string
Request Body schema: application/json
required
calledStationIdType
string
Default: "CalledStationIdTypeEnum.BSSID"
Enum: "BSSID" "AP_MAC" "NONE" "AP_GROUP"
nasIdDelimiter
string
Default: "NasIdDelimiterEnum.DASH"
Enum: "DASH" "COLON"
nasIdType
string
Default: "NasIdTypeEnum.BSSID"
Enum: "USER" "BSSID" "AP_MAC" "VENUE_NAME"
nasMaxRetry
integer <int32> [ 2 .. 10 ]
Default: 2
nasReconnectPrimaryMin
integer <int32> [ 1 .. 300 ]
Default: 5
nasRequestTimeoutSec
integer <int32> [ 2 .. 20 ]
Default: 3
overrideEnabled
boolean
Default: false
singleSessionIdAccounting
boolean
Default: false
userDefinedNasId
string [ 2 .. 64 ] characters ^((?!`|\$\()[ -~]){2,64}$

Responses

Request samples

Content type
application/json
{
  • "calledStationIdType": "BSSID",
  • "nasIdDelimiter": "DASH",
  • "nasIdType": "USER",
  • "nasMaxRetry": 2,
  • "nasReconnectPrimaryMin": 5,
  • "nasRequestTimeoutSec": 3,
  • "overrideEnabled": false,
  • "singleSessionIdAccounting": false,
  • "userDefinedNasId": "string"
}

Response samples

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

Get Venue Rogue AP Deprecated

Get the venue rogue AP settings. Use GET /venues/{venueId}/roguePolicySettings instead.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

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

Update Venue Rogue AP Deprecated

Update the venue rogue AP settings. Use PUT /venues/{venueId}/roguePolicySettings instead.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
required
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 AP SNMP Agent Settings Deprecated

Get AP SNMP settings for this venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
{
  • "apSnmpAgentProfileId": "string",
  • "enableApSnmp": false
}

Update Venue AP SNMP Agent Settings Deprecated

Update AP SNMP settings of this venue.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
required
apSnmpAgentProfileId
string
enableApSnmp
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "apSnmpAgentProfileId": "string",
  • "enableApSnmp": false
}

Response samples

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

Get Venue Syslog Server Profile Settings Deprecated

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 Deprecated

Update a venue syslog server profile settings.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
required
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 Deprecated

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 Deprecated

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 Deprecated

Update the venue syslog settings.

path Parameters
venueId
required
string

Venue ID

Request Body schema: application/json
required
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 Available Channels

Get venue available channels.

path Parameters
venueId
required
string

Venue ID.

Responses

Response samples

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

Get Venue Wi-Fi Settings Deprecated

Get the venue Wi-Fi details.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

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

L2ACL Policy

Manage layer-2 ACL policy profiles.

Deactivate Layer-2 ACL Policy On Access Control Profile

Deactivate layer-2 ACL policy on access control profile.

path Parameters
accessControlProfileId
required
string

Access Control Profile ID

l2AclPolicyId
required
string

L2Acl Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Layer-2 ACL Policy On Access Control Profile

Activate layer-2 ACL policy on access control profile.

path Parameters
accessControlProfileId
required
string

Access Control Profile ID

l2AclPolicyId
required
string

L2Acl Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Delete Layer-2 ACL Policies Deprecated

Delete layer-2 ACL policies.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get Layer-2 ACL Policies Deprecated

Get layer-2 ACL policy collection.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Layer-2 ACL

Add layer-2 ACL by policy. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

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

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Layer-2 ACL

Delete layer-2 ACL by policy id. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
l2AclPolicyId
required
string

L2Acl Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Layer-2 ACL

Get layer-2 ACL by policy id.

path Parameters
l2AclPolicyId
required
string

L2Acl Policy ID

Responses

Response samples

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

Update Layer-2 ACL

Update layer-2 ACL by policy id. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
l2AclPolicyId
required
string

L2Acl Policy ID

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

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate Layer-2 ACL Policy On Wi-Fi Network

Deactivate layer-2 ACL policy on Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

l2AclPolicyId
required
string

L2Acl Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Layer-2 ACL Policy On Wi-Fi Network

Activate layer-2 ACL policy on Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

l2AclPolicyId
required
string

L2Acl Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

SNMP Agent Profile

Manage SNMP agent profiles.

Create SNMP Agent Profile

Create a new SNMP agent profile.

Request Body schema:
required
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
Array of objects (Wi-Fi_API_and_Model_Documentation_ApSnmpV2Agent) [ 0 .. 2 ] items
Array of objects (Wi-Fi_API_and_Model_Documentation_ApSnmpV3Agent) [ 0 .. 2 ] items

Responses

Request samples

Content type
{
  • "name": "string",
  • "snmpV2Agents": [
    ],
  • "snmpV3Agents": [
    ]
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete SNMP Agent Profile

Delete a SNMP agent profile.

path Parameters
snmpAgentProfileId
required
string

SNMP Agent Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get SNMP Agent Profile

Get the details for this SNMP agent profile.

path Parameters
snmpAgentProfileId
required
string

SNMP Agent Profile ID

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "snmpV2Agents": [
    ],
  • "snmpV3Agents": [
    ]
}

Update SNMP Agent Profile

Update a SNMP agent profile.

path Parameters
snmpAgentProfileId
required
string

SNMP Agent Profile ID

Request Body schema:
required
name
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
Array of objects (Wi-Fi_API_and_Model_Documentation_ApSnmpV2Agent) [ 0 .. 2 ] items
Array of objects (Wi-Fi_API_and_Model_Documentation_ApSnmpV3Agent) [ 0 .. 2 ] items

Responses

Request samples

Content type
{
  • "name": "string",
  • "snmpV2Agents": [
    ],
  • "snmpV3Agents": [
    ]
}

Response samples

Content type
{
  • "requestId": "string"
}

Get SNMP Agent Profile Settings On AP

Get the SNMP agent profile settings on AP.

path Parameters
venueId
required
string

Venue ID

serialNumber
required
string

The serial number of the AP.

Responses

Response samples

Content type
{
  • "useVenueSettings": true
}

Update SNMP Agent Profile Settings On AP

Update the SNMP agent profile settings on AP.

path Parameters
venueId
required
string

Venue ID

serialNumber
required
string

The serial number of the AP.

Request Body schema:
required
useVenueSettings
boolean
Default: true

Responses

Request samples

Content type
{
  • "useVenueSettings": true
}

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate SNMP Agent Profile On AP

Deactivate the SNMP agent profile on the AP with the venue.

path Parameters
venueId
required
string

Venue ID

serialNumber
required
string

The serial number of the AP.

snmpAgentProfileId
required
string

SNMP Agent Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate SNMP Agent Profile On AP

Activate the SNMP agent profile on the AP with the venue.

path Parameters
venueId
required
string

Venue ID

serialNumber
required
string

The serial number of the AP.

snmpAgentProfileId
required
string

SNMP Agent Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate SNMP Agent Profile On Venue

Deactivate the SNMP agent profile on the venue.

path Parameters
venueId
required
string

Venue ID

snmpAgentProfileId
required
string

SNMP Agent Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate SNMP Agent Profile On Venue

Activate the SNMP agent profile on the venue.

path Parameters
venueId
required
string

Venue ID

snmpAgentProfileId
required
string

SNMP Agent Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Device Policy

Manage device policies.

Deactivate Device Policy On Access Control Profile

Use this API command to delete a relationship between device policy and access control profile.

path Parameters
profileId
required
string

Access Control Profile ID

policyId
required
string

Device Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Device Policy On Access Control Profile

Use this API command to build a relationship between device policy and access control profile.

path Parameters
profileId
required
string

Access Control Profile ID

policyId
required
string

Device Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Delete Device-Policies Deprecated

Delete a list of device-policies.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get All Device Policies Deprecated

Get the device-policy collection.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Device-Policy

Create a new device-policy. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

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

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Device-Policy

Delete a device-policy. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
devicePolicyId
required
string

Device-policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Device-Policy

Get the device-policy details.

path Parameters
devicePolicyId
required
string

Device-policy ID

Responses

Response samples

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

Update Device-Policy

Update a device-policy. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
devicePolicyId
required
string

Device-policy ID

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

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate Device Policy On Wi-Fi Network

Use this API command to delete a relationship between device policy and Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

policyId
required
string

Device Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Device Policy On Wi-Fi Network

Use this API command to build a relationship between device policy and Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

policyId
required
string

Device Policy ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

MDNS Proxy Service Profile

Manage Multicast DNS proxy service profiles.

Delete Multicast DNS Proxy Service Profiles Deprecated

Delete a list of multicast DNS proxy service profiles.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get Multicast DNS Proxy Service Profiles Deprecated

Get the multicast DNS proxy service profiles.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Multicast DNS Proxy Service Profile Deprecated

Create a new multicast DNS proxy service profile.

Request Body schema: application/json
required
aps
Array of strings
Array of objects (Wi-Fi_API_and_Model_Documentation_MulticastDnsProxyServiceRule)
serviceName
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Content type
application/json
{
  • "aps": [
    ],
  • "rules": [
    ],
  • "serviceName": "string"
}

Response samples

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

Delete Multicast DNS Proxy Service Profile Deprecated

Delete a multicast DNS proxy service profile.

path Parameters
mDnsProxyProfileId
required
string

Multicast DNS Proxy Service Profile ID

Responses

Response samples

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

Get Multicast DNS Proxy Service Profile Deprecated

Get the multicast DNS proxy service profile details.

path Parameters
mDnsProxyProfileId
required
string

Multicast DNS Proxy profile ID

Responses

Response samples

Content type
application/json
{
  • "aps": [
    ],
  • "id": "string",
  • "rules": [
    ],
  • "serviceName": "string"
}

Update Multicast DNS Proxy Service Profile Deprecated

Update a multicast DNS proxy service profile.

path Parameters
mDnsProxyProfileId
required
string

Multicast DNS Proxy Service Profile ID

Request Body schema: application/json
required
aps
Array of strings
Array of objects (Wi-Fi_API_and_Model_Documentation_MulticastDnsProxyServiceRule)
serviceName
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Content type
application/json
{
  • "aps": [
    ],
  • "rules": [
    ],
  • "serviceName": "string"
}

Response samples

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

Deactivate Multicast DNS Proxy Service Profile for APs Deprecated

Deactivate multicast DNS proxy service profile for APs.

path Parameters
mDnsProxyProfileId
required
string

Multicast DNS Proxy Service Profile ID

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Activate Multicast DNS Proxy Service Profile for APs Deprecated

Activate multicast DNS proxy service profile for APs.

path Parameters
mDnsProxyProfileId
required
string

Multicast DNS Proxy Service Profile ID

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Create Multicast DNS Proxy Service Profile

Create a new multicast DNS proxy service profile.

Request Body schema:
required
Array of objects (Wi-Fi_API_and_Model_Documentation_MulticastDnsProxyServiceRule)
serviceName
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Content type
{
  • "rules": [
    ],
  • "serviceName": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Multicast DNS Proxy Service Profile

Delete a multicast DNS proxy service profile.

path Parameters
multicastDnsProxyProfileId
required
string

Multicast DNS Proxy Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Multicast DNS Proxy Service Profile

Get the multicast DNS proxy service profile details.

path Parameters
multicastDnsProxyProfileId
required
string

Multicast DNS Proxy profile ID

Responses

Response samples

Content type
{
  • "id": "string",
  • "rules": [
    ],
  • "serviceName": "string"
}

Update Multicast DNS Proxy Service Profile

Update a multicast DNS proxy service profile.

path Parameters
multicastDnsProxyProfileId
required
string

Multicast DNS Proxy Profile ID

Request Body schema:
required
Array of objects (Wi-Fi_API_and_Model_Documentation_MulticastDnsProxyServiceRule)
serviceName
required
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Content type
{
  • "rules": [
    ],
  • "serviceName": "string"
}

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate Multicast DNS Proxy Service Profile On the AP

Deactivate multicast DNS proxy service profile on the AP.

path Parameters
venueId
required
string

Venue ID

apSerialNumber
required
string

The serial number of the AP.

multicastDnsProxyProfileId
required
string

Multicast DNS Proxy Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Multicast DNS Proxy Service Profile On the AP

Activate multicast DNS proxy service profile on the AP.

path Parameters
venueId
required
string

Venue ID

apSerialNumber
required
string

The serial number of the AP.

multicastDnsProxyProfileId
required
string

Multicast DNS Proxy Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Multicast DNS Proxy Service Profile APs by Venue Deprecated

Get multicast DNS proxy service profile APs detail by venue.

path Parameters
venueId
required
string

Venue ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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 Deprecated

Delete client isolation allowlists.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get Client Isolation Allowlists Deprecated

Get the client isolation allowlists.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Client Isolation Allowlist Deprecated

Create a new client isolation allowlist.

Request Body schema: application/json
required
required
Array of objects (Wi-Fi_API_and_Model_Documentation_ClientIsolationAllowlistEntry) [ 1 .. 64 ] items
description
string [ 0 .. 64 ] characters
name
required
string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

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

Response samples

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

Delete Client Isolation Allowlist Deprecated

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 Deprecated

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"
}

Update Client Isolation Allowlist Deprecated

Update this client isolation allowlist.

path Parameters
clientIsolationAllowlistId
required
string

Client Isolation Allowlist ID

Request Body schema: application/json
required
required
Array of objects (Wi-Fi_API_and_Model_Documentation_ClientIsolationAllowlistEntry) [ 1 .. 64 ] items
description
string [ 0 .. 64 ] characters
name
required
string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

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

Response samples

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

Get Venue Usage Deprecated

Get a list of venues of the client isolation allowlist.

path Parameters
clientIsolationAllowlistId
required
string

Client Isolation Allowlist ID

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

Search venue name

sortField
string

Support venue name only

sortOrder
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "pageSize": 25,
  • "searchVenueNameString": "string",
  • "sortField": "string",
  • "sortOrder": "ASC"
}

Response samples

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

Client Isolation Profile

Manage client isolation profiles.

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 profile 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 profile.

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 profiles 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 profile. If either of these situations applies in your network, please contact Ruckus customer support for assistance.

Create Client Isolation Profile

Create a new client isolation profile.

Request Body schema:
required
required
Array of objects (Wi-Fi_API_and_Model_Documentation_ClientIsolationAllowlistEntry) [ 1 .. 64 ] items
description
string [ 0 .. 64 ] characters
name
required
string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Content type
{
  • "allowlist": [
    ],
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Client Isolation Profile

Delete this client isolation profile.

path Parameters
clientIsolationProfileId
required
string

Client Isolation Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Client Isolation Profile

Get the details for this client isolation profile.

path Parameters
clientIsolationProfileId
required
string

Client Isolation Profile ID

Responses

Response samples

Content type
{
  • "allowlist": [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string"
}

Update Client Isolation Profile

Update this client isolation profile.

path Parameters
clientIsolationProfileId
required
string

Client Isolation Profile ID

Request Body schema:
required
required
Array of objects (Wi-Fi_API_and_Model_Documentation_ClientIsolationAllowlistEntry) [ 1 .. 64 ] items
description
string [ 0 .. 64 ] characters
name
required
string [ 2 .. 32 ] characters (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$

Responses

Request samples

Content type
{
  • "allowlist": [
    ],
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate Client Isolation Profile On Wi-Fi Network

Deactivate the client isolation profile on the Wi-Fi network with the venue.

path Parameters
venueId
required
string

Venue ID

wifiNetworkId
required
string

Wi-Fi Network ID

clientIsolationProfileId
required
string

Client Isolation Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Client Isolation Profile On Wi-Fi Network

Activate the client isolation profile on the Wi-Fi network with the venue.

path Parameters
venueId
required
string

Venue ID

wifiNetworkId
required
string

Wi-Fi Network ID

clientIsolationProfileId
required
string

Client Isolation Profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Access Control Profile

Manage access control profiles.

Delete Multiple Access Control Profiles Deprecated

Delete multiple access control profiles by profile identities.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get All Access Control Profiles Deprecated

Get all access control profiles.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Access Control Profile

Add an access control profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/9/1.

Request Body schema:
required
object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled)

Profile ID and enabled

description
string [ 0 .. 64 ] characters
object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled)

Profile ID and enabled

object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled)

Profile ID and enabled

object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled)

Profile ID and enabled

name
required
string [ 2 .. 32 ] characters
object (Wi-Fi_API_and_Model_Documentation_RateLimiting)

Client traffic rate limiting

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Access Control Profile

Delete the specified access control profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/9/1.

path Parameters
accessControlProfileId
required
string

Access control profile identity

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get Access Control Profile

Get an access control profile by profile identity. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/9/1.

path Parameters
accessControlProfileId
required
string

Access control profile identity

Responses

Response samples

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

Update Access Control Profile

Update the specified access control profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/9/1.

path Parameters
accessControlProfileId
required
string

Access control profile identity

Request Body schema:
required
object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled)

Profile ID and enabled

description
string [ 0 .. 64 ] characters
object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled)

Profile ID and enabled

object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled)

Profile ID and enabled

object (Wi-Fi_API_and_Model_Documentation_IdAndEnabled)

Profile ID and enabled

name
required
string [ 2 .. 32 ] characters
object (Wi-Fi_API_and_Model_Documentation_RateLimiting)

Client traffic rate limiting

Responses

Request samples

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

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate Access Control Profile On Wi-Fi Network

Use this API command to delete a relationship between access control profile and Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

accessControlProfileId
required
string

Access control profile identity

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate Access Control Profile On Wi-Fi Network

Use this API command to build a relationship between access control profile and Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

accessControlProfileId
required
string

Access control profile identity

Responses

Response samples

Content type
{
  • "requestId": "string"
}

VLAN Pool

Manage VLAN pool profiles.

Delete VLAN Pools Deprecated

Use this API command to delete a VLAN pool list.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get VLAN Pools Deprecated

Use this API command to get the VLAN pool list.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add VLAN Pool Deprecated

Use this API command to create a new VLAN pool.

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

Responses

Request samples

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

Response samples

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

Query VLAN Pool Deprecated

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

Request Body schema: application/json
required
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 Deprecated

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 Deprecated

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 Deprecated

Use this API command to partial update a VLAN pool.

path Parameters
vlanPoolId
required
string

VLAN Pool ID

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

Responses

Request samples

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

Response samples

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

Update VLAN Pool Deprecated

Use this API command to update a VLAN pool.

path Parameters
vlanPoolId
required
string

VLAN Pool ID

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

Responses

Request samples

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

Response samples

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

Get VLAN Pool Venues Activations Deprecated

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

path Parameters
vlanPoolId
required
string

VLAN Pool ID

Request Body schema: application/json
required
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
}

Application Library

Manage the current tenant's application library and settings.

Get Application Library Categories

path Parameters
applicationLibraryId
required
string

The ID (version) of the application library.

Responses

Response samples

Content type
{
  • "categories": [
    ]
}

Get Application Library Applications

path Parameters
applicationLibraryId
required
string

The ID (version) of the application library.

categoryId
required
integer <int32>

The ID of the application category.

Responses

Response samples

Content type
{
  • "applications": [
    ]
}

Get Application Library Settings

Use this API to get the current application library settings.

query Parameters
type
string

Specify which type of changed application would be included in the response

changesIncluded
boolean
Default: false

Include changed application information in response

Responses

Response samples

Content type
{
  • "changedApplications": [
    ],
  • "latestReleasedDate": "2019-08-24T14:15:22Z",
  • "latestVersion": "string",
  • "releasedDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "version": "string"
}

Patch Application Library Settings

Patch application library settings.

Request Body schema:
required
Array of objects (Wi-Fi_API_and_Model_Documentation_ChangedApplication)
latestReleasedDate
string <date-time>
latestVersion
string
releasedDate
string <date-time>
updatedDate
string <date-time>
version
string

Responses

Request samples

Content type
{
  • "changedApplications": [
    ],
  • "latestReleasedDate": "2019-08-24T14:15:22Z",
  • "latestVersion": "string",
  • "releasedDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "version": "string"
}

Response samples

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

Recovery

Retrieve and set the recovery PSK.

Get Application Policies Applications Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Application Policies Categories Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Recovery PSK Deprecated

Get the PSK for the recovery network.

Responses

Response samples

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

Update Recovery PSK Deprecated

Update the PSK for the recovery network.

Request Body schema: application/json
required
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 Deprecated

Responses

Response samples

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

RADIUS Profile

Manage RADIUS Profile for New UI.

Delete RADIUS Profiles Deprecated

Delete a list of RADIUS profiles.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

List RADIUS Profiles Deprecated

List RADIUS profiles.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add RADIUS Profile

Add a RADIUS profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

Request Body schema:
required
name
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
required
object (Wi-Fi_API_and_Model_Documentation_RadiusServer)

RADIUS server

object (Wi-Fi_API_and_Model_Documentation_RadiusServer)

RADIUS server

type
string
Enum: "AUTHENTICATION" "ACCOUNTING"

Responses

Request samples

Content type
{
  • "name": "string",
  • "primary": {
    },
  • "secondary": {
    },
  • "type": "AUTHENTICATION"
}

Response samples

Content type
{
  • "requestId": "string",
  • "response": {
    }
}

Delete RADIUS Profile

Delete a specific RADIUS profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
radiusId
required
string

RADIUS server profile ID

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Get RADIUS Profile

Get a specific RADIUS profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
radiusId
required
string

RADIUS server profile ID

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "primary": {
    },
  • "secondary": {
    },
  • "type": "AUTHENTICATION"
}

Update RADIUS Profile

Update a specific RADIUS profile. Content-Type: "application/vnd.ruckus.v1+json" will be deprecated on 2024/09/01.

path Parameters
radiusId
required
string

RADIUS server profile ID

Request Body schema:
required
name
string(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
required
object (Wi-Fi_API_and_Model_Documentation_RadiusServer)

RADIUS server

object (Wi-Fi_API_and_Model_Documentation_RadiusServer)

RADIUS server

type
string
Enum: "AUTHENTICATION" "ACCOUNTING"

Responses

Request samples

Content type
{
  • "name": "string",
  • "primary": {
    },
  • "secondary": {
    },
  • "type": "AUTHENTICATION"
}

Response samples

Content type
{
  • "requestId": "string"
}

Get RADIUS Server Profile Settings On Wi-Fi Network

Get RADIUS server profile settings on Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

Responses

Response samples

Content type
{
  • "enableAccountingProxy": false,
  • "enableAuthProxy": false,
  • "macAuthMacFormat": "Lower"
}

Update RADIUS Server Profile Settings On Wi-Fi Network

Update RADIUS server profile settings on Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

Request Body schema:
required
enableAccountingProxy
boolean
Default: false
enableAuthProxy
boolean
Default: false
macAuthMacFormat
string
Enum: "Lower" "UpperDash" "UpperColon" "Upper" "LowerDash" "LowerColon"

Responses

Request samples

Content type
{
  • "enableAccountingProxy": false,
  • "enableAuthProxy": false,
  • "macAuthMacFormat": "Lower"
}

Response samples

Content type
{
  • "requestId": "string"
}

Deactivate RADIUS Server Profile On Wi-Fi Network

Use this API command to delete a relationship between RADIUS server profile and Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

radiusId
required
string

RADIUS server profile identity

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Activate RADIUS Server Profile On Wi-Fi Network

Use this API command to build a relationship between RADIUS server profile and Wi-Fi network.

path Parameters
wifiNetworkId
required
string

Wi-Fi Network ID

radiusId
required
string

RADIUS server profile identity

Responses

Response samples

Content type
{
  • "requestId": "string"
}

Application Library Settings

Manage the current tenant's application library settings.

Get Application Library Settings

Use this API to get the current application library settings.

query Parameters
type
string

Specify which type of changed application would be included in the response

changesIncluded
boolean
Default: false

Include changed application information in response

Responses

Response samples

Content type
{
  • "changedApplications": [
    ],
  • "latestReleasedDate": "2019-08-24T14:15:22Z",
  • "latestVersion": "string",
  • "releasedDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "version": "string"
}