Documentation Powered by ReDoc

Ruckus Cloud - Wi-Fi API and Model Documentation (v20.01.04)

License: Ruckus Cloud Privacy Policy Terms of Service

AP

The AP APIs are used for adding, retrieving, updating, deleting, pinging, trace-routing resetting, and rebooting APs, including AP position, bonjour gateway, LAN Ports, and AP position.

Get APs

Use this API command to get the AP list.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
page
string

page

size
string

size

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found.

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/ap
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Add APs

Use this API command to add a list of new APs.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

AP

Array
apGroupId
string

AP group ID

description
string [ 0 .. 180 ] characters

Description of the AP

name
required
string (?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$

AP name

position
object (APPosition)

AP Position

serialNumber
required
string ^[1-9][0-9]{11}$

AP Serial-Number

tags
Array of strings
venueId
required
string

Venue ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

402

Insufficient license [ENT-10003: "Insufficient Licenses"]

403

Not-authorized

404

Requested resource or related-entity not found

409

Conflict [WIFI-10120: "Non-unique AP name", APR-10130: "Serial Already Registered"]

422

Validation error [WIFI-10114: "The Service is currently not supported in the country which you entered"]

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/ap
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Response samples

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

Delete APs

Use this API command to delete a list of APs.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

List of Serial-Numbers

Array
string

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/ap
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get APs by AP-Group

Use this API command to get the AP list by an AP group.

path Parameters
tenantId
required
string

Tenant ID

apGroupId
required
string

AP group ID

query Parameters
page
string

page

size
string

size

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/ap-group/{apGroupId}/ap
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap-group/{apGroupId}/ap

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get AP

Use this API command to get the AP operational and configuration data.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/ap/{serialNumber}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apGroupId": "string",
  • "bonjourGateway":
    {
    },
  • "clientCount": 0,
  • "description": "string",
  • "externalIp": "string",
  • "firmware": "string",
  • "indoorModel": true,
  • "ip": "string",
  • "lanPorts":
    {
    },
  • "lastContacted": "string",
  • "lastUpdated": "string",
  • "mac": "string",
  • "meshRole": "string",
  • "model": "string",
  • "name": "string",
  • "position":
    {
    },
  • "radio":
    {
    },
  • "serialNumber": "string",
  • "state": "InSetupPhase",
  • "subState": "NeverContactedCloud",
  • "tags":
    [
    ],
  • "uptime_seconds": 0,
  • "venueId": "string"
}

Update AP

Use this API command to update an AP.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json

AP

apGroupId
string

AP group ID

description
string [ 0 .. 180 ] characters

Description of the AP

name
required
string (?=^((?!`|\$\()[ -_a-~]){2,32}$)^(\S.*\S)$

AP name

position
object (APPosition)

AP Position

serialNumber
required
string ^[1-9][0-9]{11}$

AP Serial-Number

tags
Array of strings
venueId
required
string

Venue ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

402

Insufficient license [ENT-10003: "Insufficient Licenses"]

403

Not-authorized

404

Requested resource or related-entity not found

409

Conflict [WIFI-10120: "Non-unique AP name"]

422

Validation error [WIFI-10114: "The Service is currently not supported in the country which you entered"]

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/ap/{serialNumber}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apGroupId": "string",
  • "description": "string",
  • "name": "string",
  • "position":
    {
    },
  • "serialNumber": "string",
  • "tags":
    [
    ],
  • "venueId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete AP

Use this API command to delete an AP.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/ap/{serialNumber}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get AP Bonjour Gateway

Use this API command to get an AP's Bonjour Gateway details.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/ap/{serialNumber}/bonjour-gateway
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/bonjour-gateway

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rules":
    [
    ]
}

Update AP Bonjour Gateway

Use this API command to update an AP's Bonjour Gateway.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json

Bonjour-gateway

rules
required
Array of objects (BonjourGatewayRule)

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/ap/{serialNumber}/bonjour-gateway
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/bonjour-gateway

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rules":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Reset AP Bonjour Gateway

Use this API command to reset an AP's Bonjour Gateway.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/ap/{serialNumber}/bonjour-gateway
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/bonjour-gateway

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Download AP Log

Use this API command to download the AP log file.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/ap/{serialNumber}/download-log
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/download-log

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fileURL": "string"
}

Factory Reset AP

Use this API command to perform a factory reset on an AP.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/ap/{serialNumber}/factory-reset
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/factory-reset

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get AP LAN-Ports

Use this API command to get AP LAN-ports details.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/ap/{serialNumber}/lan-port
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/lan-port

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "lanPorts":
    [
    ],
  • "poeOut": null,
  • "useVenueSettings": false
}

Update AP LAN-Ports

Use this API command to update the LAN ports of an AP.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json

AP LAN-Ports

lanPorts
Array of objects (APLanPort)
poeOut
boolean
Default: null

True if POE out is enabled

useVenueSettings
boolean
Default: false

True if using Venue POE settings

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error [WIFI-10108: "AP LAN-Port type is Trunk and UntagId != 1", WIFI-10109: "AP LAN-Port type is Access and UntagId is not equals to VlanMembers"]

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/ap/{serialNumber}/lan-port
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/lan-port

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "lanPorts":
    [
    ],
  • "poeOut": null,
  • "useVenueSettings": false
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Reset AP LAN-Ports

Use this API command to reset the LAN ports of an AP to the default values.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/ap/{serialNumber}/lan-port
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/lan-port

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Ping AP

Use this API command to perform a ping to the AP.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json

AP Ping-request

targetHost
required
string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b)$)

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/ap/{serialNumber}/ping
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/ping

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "targetHost": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Update AP Position

Use this API command to update the position of an AP.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json

AP position

floorplanId
string
xPercent
number <float> [ 0 .. 100 ]
yPercent
number <float> [ 0 .. 100 ]

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/ap/{serialNumber}/position
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/position

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get AP Radio

Use this API command to get AP radio details.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/ap/{serialNumber}/radio
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/radio

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apRadioParams24G":
    {
    },
  • "apRadioParams50G":
    {
    },
  • "enable24G": null,
  • "enable50G": null,
  • "useVenueSettings": true
}

Update AP Radio

Use this API command to update the AP radio settings.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json

AP Radio

apRadioParams24G
object (APRadioParams24G)

AP Radio params for 2.4 Ghz

apRadioParams50G
object (APRadioParams50G)

AP Radio params for 5 Ghz

enable24G
boolean
Default: null

True if 2.4 Ghz is enabled

enable50G
boolean
Default: null

True if 5 Ghz is enabled

useVenueSettings
boolean
Default: true

True if using Venue settings

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error [WIFI-10110: "Radio Params 2.4G, Allowed Channel List, At Least Two Channels Should Be Selected", WIFI-10111: "Radio Params 5G, Allowed Indoor Channel List, At Least Two Channels Should Be Selected", WIFI-10112: "Radio Params 5G, Allowed Outdoor Channel List, At Least Two Channels Should Be Selected"]

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/ap/{serialNumber}/radio
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/radio

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apRadioParams24G":
    {
    },
  • "apRadioParams50G":
    {
    },
  • "enable24G": null,
  • "enable50G": null,
  • "useVenueSettings": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Reset AP Radio Customization

Use this API command to reset AP radio to default settings.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/ap/{serialNumber}/radio
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/radio

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Reboot AP

Use this API command to reboot an AP.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/ap/{serialNumber}/reboot
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/reboot

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Trace-Route AP

Use this API command to perform a trace-route on an AP.

path Parameters
tenantId
required
string

Tenant ID

serialNumber
required
string

The serial number of the AP.

Request Body schema: application/json

AP Trace-route request

targetHost
required
string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b)$)

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/ap/{serialNumber}/trace-route
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap/{serialNumber}/trace-route

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "targetHost": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

AP-Group

The AP-Group APIs are used for creating, retrieving, updating, and deleting and AP group.

Get AP-Groups

Use this API command to get the AP group list.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
page
string

page

size
string

size

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/ap-group
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap-group

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create AP-Group

Use this API command to create a new AP group.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

AP-Group

name
required
string [ 2 .. 64 ] characters

Name of the AP group

description
string [ 2 .. 180 ] characters

Description of the AP group

venueId
required
string

Immutable: The venue is set when creating the AP-group, and cannot be changed afterwards.

apSerialNumbers
Array of objects (APSerialNumber)

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/ap-group
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap-group

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete AP-Groups

Use this API command to delete a list of AP groups.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

List of AP-group IDs

Array
string

AP-group ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/ap-group
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap-group

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get AP-Group

Use this API command to get the AP group details.

path Parameters
apGroupId
required
string

AP group ID

tenantId
required
string

Tenant ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/ap-group/{apGroupId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap-group/{apGroupId}

Response samples

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

Update AP-Group

Use this API command to update an AP group.

path Parameters
apGroupId
required
string

AP group ID

tenantId
required
string

Tenant ID

Request Body schema: application/json

AP-Group

name
required
string [ 2 .. 64 ] characters

Name of the AP group

description
string [ 2 .. 180 ] characters

Description of the AP group

venueId
required
string

Immutable: The venue is set when creating the AP-group, and cannot be changed afterwards.

apSerialNumbers
Array of objects (APSerialNumber)

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/ap-group/{apGroupId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap-group/{apGroupId}

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete AP-Group

Use this API command to delete an AP group.

path Parameters
tenantId
required
string

Tenant ID

apGroupId
required
string

AP group ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/ap-group/{apGroupId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/ap-group/{apGroupId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get AP-Groups by Venue

Use this API command to get the AP group list by venue.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

query Parameters
page
string

page

size
string

size

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/venue/{venueId}/ap-group
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/ap-group

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Venue Default AP-Group

Use this API command to get venue default AP group details.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/venue/{venueId}/default-ap-group
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/default-ap-group

Response samples

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

Venue

The Venue APIs are used for creating, retrieving, updating, deleting, and resetting venue information, including AP Radio settings, Mesh, LEDs, Regulatory Channels, LAN Ports, Syslogs, and vSPot server.

Get Venues

Use this API command to get the venue list.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
page
string

page

size
string

size

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/venue
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Venue

Use this API command to get the venue details.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/venue/{venueId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apPassword": "string",
  • "bandBalancing":
    {
    },
  • "id": "string",
  • "mesh":
    {
    },
  • "radioCustomization":
    {
    },
  • "syslog":
    {
    },
  • "tenantId": "string"
}

Get Venue LAN-Ports

Use this API command to list venue LAN port settings. The settings are defined per AP model.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/venue/{venueId}/lan-port
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/lan-port

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Update Venue LAN-Ports

Use this API command to update venue LAN port settings. The settings are defined per AP model.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Request Body schema: application/json

AP-Model LAN-Port

Array
lanPorts
Array of objects (VenueLanPort)
model
string [ 0 .. 64 ] characters
poeMode
string
Enum: "Auto" "802.3af" "802.3at" "802.3bt-Class_5" "802.3bt-Class_6" "802.3bt-Class_7" "802.3bt-Class_8"
poeOut
boolean
Default: null

True if POE out is enabled

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error [WIFI-10108: "AP LanPort type is Trunk and UntagId != 1", WIFI-10109: "AP LanPort type is Access and UntagId is not equals to VlanMembers"]

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/venue/{venueId}/lan-port
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/lan-port

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Response samples

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

Get Venue LED

Use this API command to get Venue LED list per AP model.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/venue/{venueId}/led
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/led

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Update Venue LED

Use this API command to update Venue LED list per AP model.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Request Body schema: application/json

AP-Model LED

Array
ledEnabled
boolean
Default: null

True if LED is enabled

model
string [ 0 .. 64 ] characters

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error [WIFI-10108: "AP LanPort type is Trunk and UntagId != 1", WIFI-10109: "AP LanPort type is Access and UntagId is not equals to VlanMembers"]

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/venue/{venueId}/led
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/led

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Response samples

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

Update Mesh

Use this API command to update the venue mesh.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Request Body schema: application/json

Mesh

enabled
boolean
Default: false

default: false

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

409

Conflict [WIFIB-10001: "Disabling mesh with active APs is not allowed"]

422

Validation error

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/venue/{venueId}/mesh
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/mesh

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": false
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Venue Radio

Use this API command to get the venue radio.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/venue/{venueId}/radio
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/radio

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "radioParams24G":
    {
    },
  • "radioParams50G":
    {
    }
}

Update venue radio

Use this API command to update the venue radio.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Request Body schema: application/json

Venue Radio

radioParams24G
object (RadioParams24G)

Radio customization for 2.4 Ghz

radioParams50G
object (RadioParams50G)

Radio customization for 5 Ghz

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error [WIFI-10110: "Radio Params 2.4G, Allowed Channel List, At Least Two Channels Should Be Selected", WIFI-10111: "Radio Params 5G, Allowed Indoor Channel List, At Least Two Channels Should Be Selected", WIFI-10112: "Radio Params 5G, Allowed Outdoor Channel List, At Least Two Channels Should Be Selected"]

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/venue/{venueId}/radio
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/radio

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "radioParams24G":
    {
    },
  • "radioParams50G":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Reset Venue Radio

Use this API command to reset venue radio to default values.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/venue/{venueId}/radio
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/radio

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Default Radio

Use this API command to get the venue radio default values.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/venue/{venueId}/radio/default
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/radio/default

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "radioParams24G":
    {
    },
  • "radioParams50G":
    {
    }
}

Get Venue Syslog

Use this API command to get the venue syslog settings.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/venue/{venueId}/syslog
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/syslog

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": false,
  • "facility": "KEEP_ORIGINAL",
  • "flowLevel": "CLIENT_FLOW",
  • "port": 514,
  • "priority": "ERROR",
  • "protocol": "UDP",
  • "secondaryPort": 514,
  • "secondaryProtocol": "TCP",
  • "secondaryServer": "string",
  • "server": "string"
}

Update Venue Syslog

Use this API command to update the venue syslog settings.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Request Body schema: application/json

Venue Syslog

enabled
boolean
Default: false

default: false

facility
string
Default: "KEEP_ORIGINAL"
Enum: "KEEP_ORIGINAL" "LOCAL0" "LOCAL1" "LOCAL2" "LOCAL3" "LOCAL4" "LOCAL5" "LOCAL6" "LOCAL7"

default: FacilityEnum.KEEP_ORIGINAL

flowLevel
string
Default: "CLIENT_FLOW"
Enum: "GENERAL_LOGS" "CLIENT_FLOW" "ALL"

default: FlowLevelEnum.CLIENT_FLOW

port
integer <int32> [ 1 .. 65535 ]
Default: 514

default: 514

priority
string
Default: "ERROR"
Enum: "EMERGENCY" "ALERT" "CRITICAL" "ERROR" "WARNING" "NOTICE" "INFO" "ALL"

default: PriorityEnum.ERROR

protocol
string
Default: "UDP"
Enum: "TCP" "UDP"

default: ProtocolEnum.UDP

secondaryPort
integer <int32> [ 1 .. 65535 ]
Default: 514

default: 514

secondaryProtocol
string
Default: "TCP"
Enum: "TCP" "UDP"

default: ProtocolEnum.TCP

secondaryServer
string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(([a-zA-Z]{1})|([a-zA-Z]{1}[a-zA-Z]{1})|([a-zA-Z]{1}[0-9]{1})|([0-9]{1}[a-zA-Z]{1})|([a-zA-Z0-9][a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]))\.([a-zA-Z]{2,6}|[a-zA-Z0-9-]{2,30}\.[a-zA-Z]{2,3})$)
server
string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(([a-zA-Z]{1})|([a-zA-Z]{1}[a-zA-Z]{1})|([a-zA-Z]{1}[0-9]{1})|([0-9]{1}[a-zA-Z]{1})|([a-zA-Z0-9][a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]))\.([a-zA-Z]{2,6}|[a-zA-Z0-9-]{2,30}\.[a-zA-Z]{2,3})$)

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/venue/{venueId}/syslog
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/syslog

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": false,
  • "facility": "KEEP_ORIGINAL",
  • "flowLevel": "CLIENT_FLOW",
  • "port": 514,
  • "priority": "ERROR",
  • "protocol": "UDP",
  • "secondaryPort": 514,
  • "secondaryProtocol": "TCP",
  • "secondaryServer": "string",
  • "server": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Reset Venue Syslog

Use this API command to reset venue syslog settings to default values.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/venue/{venueId}/syslog
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/syslog

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Venue Default Regulatory-Channels

Use this API command to get venue default regulatory channels.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/venue/{venueId}/valid-channels
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/valid-channels

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "2.4GChannels":
    {
    },
  • "5GChannels":
    {
    }
}

Get Venue vSPoT

Use this API command to get the vSPoT details of a venue.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/venue/{venueId}/vspot
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/vspot

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "password": "stringst",
  • "port": 8883,
  • "serverAddress": "string",
  • "serverName": "string",
  • "venues":
    [
    ],
  • "vspotGlobalId": "string"
}

Unbind Venue vSPoT

Use this API command to unbind a venue from the vSPoT server.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/venue/{venueId}/vspot
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/vspot

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Bind Venue Vspot

Use this API command to bind a venue to the vSPoT server.

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

vspotId
required
string

vspotId

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/venue/{venueId}/vspot/{vspotId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/vspot/{vspotId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Network

The Network APIs are used for creating, retrieving, updating, and deleting a network.

Get Networks

Use this API command to get the network list.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
page
string

page

size
string

size

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/network
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create Network

Use this API command to create a new network.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

Network

name
required
string (?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$
description
string [ 0 .. 255 ] characters
type
required
string
aaa
authRadiusId
required
string

The RADIUS authentication ID

accountingRadiusId
string

The RADIUS accounting ID

wlan
required
object (AAAWlan)

WLAN

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error [WIFI-10100: "PSK passphrase not null when security equals WPAPersonal or WPA2Personal", WIFI-10101: "PSK WepHex key not null when security equals WEP", WIFI-10105: "Invalid Guest Network attributes, When user session timeout is set, the session grace period value must be equal or lower", WIFI-10106: "Only OFDM PHY rates are permitted", WIFI-10107: "When OFDM only is selected, the Management Tx Rate must be greater than or equal to the BSS Minimum Rate"]

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/network
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network

Request samples

Content type
application/json
Example
aaa
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "type": "aaa",
  • "authRadiusId": "string",
  • "accountingRadiusId": "string",
  • "wlan":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete Networks

Use this API command to delete a list of networks.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

List of Network IDs

Array
string

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/network
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Create Network (Deep)

Use this API command to create a new network (deep).

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

NetworkDeep

name
required
string (?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$
description
string [ 0 .. 255 ] characters
venues
Array of objects (NetworkVenue)
type
required
string
aaa
authRadius
required
object (Radius)

Primary and secondary RADIUS servers

accountingRadius
object (Radius)

Primary and secondary RADIUS servers

wlan
required
object (AAAWlan)

WLAN

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error [WIFI-10100: "PSK passphrase not null when security equals WPAPersonal or WPA2Personal", WIFI-10101: "PSK WepHex key not null when security equals WEP", WIFI-10105: "Invalid Guest Network attributes, When user session timeout is set, the session grace period value must be equal or lower", WIFI-10106: "Only OFDM PHY rates are permitted", WIFI-10107: "When OFDM only is selected, the Management Tx Rate must be greater than or equal to the BSS Minimum Rate", WIFI-10103: "Port 1813 is not permitted", WIFI-10104: "Port 1812 is not permitted", WIFI-10116: "Invalid External Provider name and region"]

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/network/deep
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network/deep

Request samples

Content type
application/json
Example
aaa
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "venues":
    [
    ],
  • "type": "aaa",
  • "authRadius":
    {
    },
  • "accountingRadius":
    {
    },
  • "wlan":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Network DPSK Passphrase Formats

Use this API command to get the DPSK passphrase format list.

path Parameters
tenantId
required
string

Tenant ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/network/dpsk
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network/dpsk

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Network

Use this API command to get the network details.

path Parameters
tenantId
required
string

Tenant ID

networkId
required
string

Network ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/network/{networkId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network/{networkId}

Response samples

Content type
application/json
Example
aaa
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "type": "aaa",
  • "authRadiusId": "string",
  • "accountingRadiusId": "string",
  • "wlan":
    {
    }
}

Update Network

Use this API command to update a network.

path Parameters
tenantId
required
string

Tenant ID

networkId
required
string

Network ID

Request Body schema: application/json

Network

name
required
string (?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$
description
string [ 0 .. 255 ] characters
type
required
string
aaa
authRadiusId
required
string

The RADIUS authentication ID

accountingRadiusId
string

The RADIUS accounting ID

wlan
required
object (AAAWlan)

WLAN

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error [WIFI-10100: "PSK passphrase not null when security equals WPAPersonal or WPA2Personal", WIFI-10101: "PSK WepHex key not null when security equals WEP", WIFI-10105: "Invalid Guest Network attributes, When user session timeout is set, the session grace period value must be equal or lower", WIFI-10106: "Only OFDM PHY rates are permitted", WIFI-10107: "When OFDM only is selected, the Management Tx Rate must be greater than or equal to the BSS Minimum Rate"]

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/network/{networkId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network/{networkId}

Request samples

Content type
application/json
Example
aaa
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "type": "aaa",
  • "authRadiusId": "string",
  • "accountingRadiusId": "string",
  • "wlan":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete Network

Use this API command to delete a network.

path Parameters
tenantId
required
string

Tenant ID

networkId
required
string

Network ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/network/{networkId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network/{networkId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get Network (Deep)

Use this API command to get network details, including the nested details.

path Parameters
tenantId
required
string

Tenant ID

networkId
required
string

Network ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/network/{networkId}/deep
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network/{networkId}/deep

Response samples

Content type
application/json
Example
aaa
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "venues":
    [
    ],
  • "type": "aaa",
  • "authRadius":
    {
    },
  • "accountingRadius":
    {
    },
  • "wlan":
    {
    }
}

Update Network (Deep)

Update a network

path Parameters
tenantId
required
string

Tenant ID

networkId
required
string

Network ID

Request Body schema: application/json

NetworkDeep

name
required
string (?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$
description
string [ 0 .. 255 ] characters
venues
Array of objects (NetworkVenue)
type
required
string
aaa
authRadius
required
object (Radius)

Primary and secondary RADIUS servers

accountingRadius
object (Radius)

Primary and secondary RADIUS servers

wlan
required
object (AAAWlan)

WLAN

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error [WIFI-10100: "PSK passphrase not null when security equals WPAPersonal or WPA2Personal", WIFI-10101: "PSK WepHex key not null when security equals WEP", WIFI-10105: "Invalid Guest Network attributes, When user session timeout is set, the session grace period value must be equal or lower", WIFI-10106: "Only OFDM PHY rates are permitted", WIFI-10107: "When OFDM only is selected, the Management Tx Rate must be greater than or equal to the BSS Minimum Rate", WIFI-10103: "Port 1813 is not permitted", WIFI-10104: "Port 1812 is not permitted", WIFI-10116: "Invalid External Provider name and region"]

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/network/{networkId}/deep
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network/{networkId}/deep

Request samples

Content type
application/json
Example
aaa
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "venues":
    [
    ],
  • "type": "aaa",
  • "authRadius":
    {
    },
  • "accountingRadius":
    {
    },
  • "wlan":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Network-Venue

The Network-Venue APIs are used for creating, retrieving, updating, and deleting network-venues.

Create Network-Venue

Use this API command to create a new network-venue association.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

Network-Venue

allAPGroupsRadio
string
Default: "Both"
Enum: "Both" "2.4-GHz" "5-GHz"

default: RadioEnum.Both

allAPGroupsVlanId
integer <int32> [ 1 .. 4094 ]
apGroups
Array of objects (NetworkAPGroup)
isAllAPGroups
boolean
Default: true

default: true

networkId
string

Network ID

scheduler
object (NetworkVenueScheduler)

Network venue scheduler

venueId
string

Venue ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/network-venue
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network-venue

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "allAPGroupsRadio": "Both",
  • "allAPGroupsVlanId": 1,
  • "apGroups":
    [
    ],
  • "isAllAPGroups": true,
  • "networkId": "string",
  • "scheduler":
    {
    },
  • "venueId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete Network-Venues

Use this API command to delete a list of network-venue associations.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

List of Network-Venue IDs

Array
string

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/network-venue
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network-venue

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get Network-Venue

Use this API command to get the network-venue association details.

path Parameters
tenantId
required
string

Tenant ID

networkVenueId
required
string

Network-Venue ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/network-venue/{networkVenueId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network-venue/{networkVenueId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "allAPGroupsRadio": "Both",
  • "allAPGroupsVlanId": 1,
  • "apGroups":
    [
    ],
  • "id": "string",
  • "isAllAPGroups": true,
  • "networkId": "string",
  • "scheduler":
    {
    },
  • "venueId": "string"
}

Update Network-Venue

Use this API command to update a network-venue association.

path Parameters
tenantId
required
string

Tenant ID

networkVenueId
required
string

Network-Venue ID

Request Body schema: application/json

Network-Venue

allAPGroupsRadio
string
Default: "Both"
Enum: "Both" "2.4-GHz" "5-GHz"

default: RadioEnum.Both

allAPGroupsVlanId
integer <int32> [ 1 .. 4094 ]
apGroups
Array of objects (NetworkAPGroup)
isAllAPGroups
boolean
Default: true

default: true

networkId
string

Network ID

scheduler
object (NetworkVenueScheduler)

Network venue scheduler

venueId
string

Venue ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/network-venue/{networkVenueId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network-venue/{networkVenueId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "allAPGroupsRadio": "Both",
  • "allAPGroupsVlanId": 1,
  • "apGroups":
    [
    ],
  • "isAllAPGroups": true,
  • "networkId": "string",
  • "scheduler":
    {
    },
  • "venueId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete Network-Venue

Use this API command to delete a network-venue association.

path Parameters
tenantId
required
string

Tenant ID

networkVenueId
required
string

Network-Venue ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/network-venue/{networkVenueId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network-venue/{networkVenueId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get Network-Venues

Use this API command to get network-venue association list.

path Parameters
tenantId
required
string

Tenant ID

networkId
required
string

Network ID

query Parameters
page
string

page

size
string

size

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/network/{networkId}/network-venue
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network/{networkId}/network-venue

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Network-Venue by Network and Venue

Use this API command to get network-venue association by network and venue.

path Parameters
tenantId
required
string

Tenant ID

networkId
required
string

Network ID

venueId
required
string

Venue ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/network/{networkId}/venue/{venueId}/network-venue
https://ruckus.cloud/api/tenant/{tenantId}/wifi/network/{networkId}/venue/{venueId}/network-venue

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "allAPGroupsRadio": "Both",
  • "allAPGroupsVlanId": 1,
  • "apGroups":
    [
    ],
  • "id": "string",
  • "isAllAPGroups": true,
  • "networkId": "string",
  • "scheduler":
    {
    },
  • "venueId": "string"
}

Get Venue-Network Associations

Use this API command to get venue-network association list

path Parameters
tenantId
required
string

Tenant ID

venueId
required
string

Venue ID

query Parameters
page
string

page

size
string

size

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/venue/{venueId}/venue-network
https://ruckus.cloud/api/tenant/{tenantId}/wifi/venue/{venueId}/venue-network

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

WiFi-Client

The WiFi-Client API is used for disconnecting a list of clients.

Disconnect Clients

Use this API command to disconnect a list of clients.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

Disconnect client

Array
apMac
required
string

The MAC address of the AP

clientMac
required
string

The MAC address of the client

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found [WIFI-10201: "Client not found (may have been previously disconnected)"].

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/disconnect-client
https://ruckus.cloud/api/tenant/{tenantId}/wifi/disconnect-client

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Guest-user

The Guest-user APIs are used for manage guest-users

Get Guest-users

Use this API command to get the guest users list.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
page
string
Default: "1"

page

size
string
Default: "50"

size

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/guest-user
https://ruckus.cloud/api/tenant/{tenantId}/wifi/guest-user

Response samples

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

Create Guest-users

Use this API command to create a list of new guest users.

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

guestsPayload

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

At least one

disabled
boolean
email
string

The email of the guest user

expiration
required
object (GuestUserExpiration)
maxDevices
required
integer <int32>

Maximum number of devices on which the guest pass can be used simultaneously. Set to -1 for unlimited number of devices.

mobilePhoneNumber
required
string

The mobile number of the guest user

name
required
string

The name of the guest user

networkId
required
string

The network that the guest can connect to

notes
string [ 0 .. 180 ] characters

Responses

201

Created

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/guest-user
https://ruckus.cloud/api/tenant/{tenantId}/wifi/guest-user

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Response samples

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

Delete Guest-users

Use this API command to delete a list of guest users.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

ids

Array
string

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/guest-user
https://ruckus.cloud/api/tenant/{tenantId}/wifi/guest-user

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Import Guest-users

Use this API command to import list of new guest users from a file.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
networkId
required
string

Network ID

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

deliveryMethods

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

expiration.activationType

expiration.duration
required
integer <int32> [ 1 .. 8760 ]

expiration.duration

expiration.unit
required
string
Enum: "Minute" "Hour" "Day" "Week" "Month" "Year" "Never"

expiration.unit

maxDevices
required
integer <int32>

maxDevices

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

file

Responses

201

Created

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/guest-user/import
https://ruckus.cloud/api/tenant/{tenantId}/wifi/guest-user/import

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Guest-user

Use this API command to get the guest user details.

path Parameters
tenantId
required
string

Tenant ID

guestUserId
required
string

The guest user ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/guest-user/{guestUserId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/guest-user/{guestUserId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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"
}

Delete Guest-user by ID

Use this API command to delete a guest user.

path Parameters
tenantId
required
string

Tenant ID

guestUserId
required
string

Guest user ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/guest-user/{guestUserId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/guest-user/{guestUserId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Disable Guest-user

Use this API command to disable a guest user

path Parameters
tenantId
required
string

Tenant ID

guestUserId
required
string

Guest user ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/guest-user/{guestUserId}/disable
https://ruckus.cloud/api/tenant/{tenantId}/wifi/guest-user/{guestUserId}/disable

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Enable Guest-user

Use this API command to enable a guest user.

path Parameters
tenantId
required
string

Tenant ID

guestUserId
required
string

Guest user ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/guest-user/{guestUserId}/enable
https://ruckus.cloud/api/tenant/{tenantId}/wifi/guest-user/{guestUserId}/enable

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Regenerate Guest-user Credentials

Use this API command to regenerate a guest user credentials.

path Parameters
tenantId
required
string

Tenant ID

guestUserId
required
string

Guest user ID

Request Body schema: application/json

Delivery Methods

Array
string
Enum: "MAIL" "SMS" "STUB" "PRINT"

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/guest-user/{guestUserId}/regenerate
https://ruckus.cloud/api/tenant/{tenantId}/wifi/guest-user/{guestUserId}/regenerate

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "MAIL"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Recovery

The Recovery APIs are used for retrieving and updating the recovery PSK.

Get Recovery PSK

Use this API command to get the PSK for the recovery network.

path Parameters
tenantId
required
string

Tenant ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/recovery
https://ruckus.cloud/api/tenant/{tenantId}/wifi/recovery

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "psk": "string",
  • "tenantId": "string"
}

Update Recovery Psk

Use this API command to update the PSK for the recovery network.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

Recovery PSK

psk
string ^([0-9]{4}){4}$
tenantId
string

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/recovery
https://ruckus.cloud/api/tenant/{tenantId}/wifi/recovery

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "psk": "string",
  • "tenantId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

DPSK Passphrase

The DPSK Passphrase APIs are used for creating and deleting the DPSK passphrase.

Creat DPSK Passphrase

Use this API command to create a new DPSK passphrase.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

DPSK Passphrase

expiration
integer <int64>
mac
required
string ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$|^([0-9A-Fa-f]{12})$
networkId
string

Network ID

override
boolean
Default: false

True if overriding

passphrase
string [ 8 .. 63 ] characters
username
string [ 0 .. 200 ] characters
vlanId
integer <int32> [ 1 .. 4094 ]
Default: 1

VLAN ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error [WIFI-10102: "DPSK passphrase not null when security equals WPAPersonal or WPA2Personal"]

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/dpsk
https://ruckus.cloud/api/tenant/{tenantId}/wifi/dpsk

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "expiration": 0,
  • "mac": "string",
  • "networkId": "string",
  • "override": false,
  • "passphrase": "stringst",
  • "username": "string",
  • "vlanId": 1
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete DPSK Passphrases

Use this API command to delete a list of DPSK passphrases.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

List of DPSK Passphrase IDs

Array
string

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/dpsk
https://ruckus.cloud/api/tenant/{tenantId}/wifi/dpsk

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

vSPoT

The vSPoT APIs are used for creating, retrieving, updating, and deleting the vSPoT server.

Get vSPoTs

Use this API command to get the vSPoT server list.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
page
string

page

size
string

size

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/vspot
https://ruckus.cloud/api/tenant/{tenantId}/wifi/vspot

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create vSPoT

Use this API command to create a new vSPoT server.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

vSPOT

password
required
string [ 8 .. 63 ] characters ^(?!(`|\$))[!-~]{8,63}$
port
integer <int32> [ 1 .. 65535 ]
Default: 8883

default: 8883

serverAddress
required
string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(([a-zA-Z]{1})|([a-zA-Z]{1}[a-zA-Z]{1})|([a-zA-Z]{1}[0-9]{1})|([0-9]{1}[a-zA-Z]{1})|([a-zA-Z0-9][a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]))\.([a-zA-Z]{2,6}|[a-zA-Z0-9-]{2,30}\.[a-zA-Z]{2,3})$)
serverName
required
string (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
venues
Array of objects (VspotVenue)
vspotGlobalId
string

The vSPoT global ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/vspot
https://ruckus.cloud/api/tenant/{tenantId}/wifi/vspot

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "password": "stringst",
  • "port": 8883,
  • "serverAddress": "string",
  • "serverName": "string",
  • "venues":
    [
    ],
  • "vspotGlobalId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Vspot

Use this API command to get the vSPoT server details.

path Parameters
tenantId
required
string

Tenant ID

vspotId
required
string

vspotId

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/vspot/{vspotId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/vspot/{vspotId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "password": "stringst",
  • "port": 8883,
  • "serverAddress": "string",
  • "serverName": "string",
  • "venues":
    [
    ],
  • "vspotGlobalId": "string"
}

Update Vspot

Use this API command to update a vSPoT server.

path Parameters
tenantId
required
string

Tenant ID

vspotId
required
string

vspotId

Request Body schema: application/json

vSPOT

password
required
string [ 8 .. 63 ] characters ^(?!(`|\$))[!-~]{8,63}$
port
integer <int32> [ 1 .. 65535 ]
Default: 8883

default: 8883

serverAddress
required
string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(([a-zA-Z]{1})|([a-zA-Z]{1}[a-zA-Z]{1})|([a-zA-Z]{1}[0-9]{1})|([0-9]{1}[a-zA-Z]{1})|([a-zA-Z0-9][a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]))\.([a-zA-Z]{2,6}|[a-zA-Z0-9-]{2,30}\.[a-zA-Z]{2,3})$)
serverName
required
string (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
venues
Array of objects (VspotVenue)
vspotGlobalId
string

The vSPoT global ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/vspot/{vspotId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/vspot/{vspotId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "password": "stringst",
  • "port": 8883,
  • "serverAddress": "string",
  • "serverName": "string",
  • "venues":
    [
    ],
  • "vspotGlobalId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete Vspot

Use this API command to delete a vSPoT server.

path Parameters
tenantId
required
string

Tenant ID

vspotId
required
string

vspotId

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/vspot/{vspotId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/vspot/{vspotId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

WiFi Calling

The Wi-Fi Calling APIs are used for creating, retrieving, updating, and deleting Wi-Fi calling profiles.

Get WiFi Calling Profiles

Use this API command to get the Wi-Fi Calling profiles.

path Parameters
tenantId
required
string

Tenant ID

query Parameters
page
string

page

size
string

size

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/wifi-calling-profile
https://ruckus.cloud/api/tenant/{tenantId}/wifi/wifi-calling-profile

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create WiFi Calling Profile

Use this API command to create a new Wi-Fi Calling profile.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

Wi-Fi Calling Profile

description
string [ 2 .. 180 ] characters
ePDGs
required
Array of objects (Epdg)
profileName
required
string (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
qosPriority
string
Default: "WIFICALLING_PRI_VOICE"
Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG"

default: QosPriorityEnum.WIFICALLING_PRI_VOICE

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/wifi/wifi-calling-profile
https://ruckus.cloud/api/tenant/{tenantId}/wifi/wifi-calling-profile

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete WiFi Calling Profiles

Use this API command to delete a list of Wi-Fi Calling profiles.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

List of Wi-Fi Calling Profile IDs

Array
string

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/wifi-calling-profile
https://ruckus.cloud/api/tenant/{tenantId}/wifi/wifi-calling-profile

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get WiFi Calling Profile

Use this API command to get the Wi-Fi Calling profile details.

path Parameters
tenantId
required
string

Tenant ID

wifiCallingProfileId
required
string

Wi-Fi calling profile ID

Responses

200

OK

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/wifi/wifi-calling-profile/{wifiCallingProfileId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/wifi-calling-profile/{wifiCallingProfileId}

Response samples

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

Update WiFi Calling Profile

Use this API command to update a Wi-Fi Calling profile.

path Parameters
tenantId
required
string

Tenant ID

wifiCallingProfileId
required
string

Wi-Fi calling profile ID

Request Body schema: application/json

Wi-Fi Calling Profile

description
string [ 2 .. 180 ] characters
ePDGs
required
Array of objects (Epdg)
profileName
required
string (?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$
qosPriority
string
Default: "WIFICALLING_PRI_VOICE"
Enum: "WIFICALLING_PRI_VOICE" "WIFICALLING_PRI_VIDEO" "WIFICALLING_PRI_BE" "WIFICALLING_PRI_BG"

default: QosPriorityEnum.WIFICALLING_PRI_VOICE

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

put /api/tenant/{tenantId}/wifi/wifi-calling-profile/{wifiCallingProfileId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/wifi-calling-profile/{wifiCallingProfileId}

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete WiFi Calling Profile

Use this API command to delete a Wi-Fi Calling profile.

path Parameters
tenantId
required
string

Tenant ID

wifiCallingProfileId
required
string

Wi-Fi calling profile ID

Responses

200

OK

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

delete /api/tenant/{tenantId}/wifi/wifi-calling-profile/{wifiCallingProfileId}
https://ruckus.cloud/api/tenant/{tenantId}/wifi/wifi-calling-profile/{wifiCallingProfileId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}