Ruckus Network Director 3.0
[ Base URL: /api/v3.0/ ]
Ruckus Management platform for SZ Controllers.
APConfigure and get details of accesspoints
Configure and get details of accesspoints
ClustersConfigure and get details of Clusters
Configure and get details of Clusters
Admin Activity LogsConfigure and get details of Clusters
Configure and get details of Clusters
Application LogsConfigure and get details of Application Logs
Configure and get details of Application Logs
GET/applicationlogs/downloadallfiles/{type}/{downloadfile}
Download application logs file for a particular type
Config BackupConfigure and get details of Config Backup
Configure and get details of Config Backup
Back Process Scheduler ConfigurationConfigure and get details of Back Process Scheduler
Configure and get details of Back Process Scheduler
NotificationsConfigure and get details of Notifications
Configure and get details of Notifications
AP IP/Subnet Provision RulesConfigure and get details of AP IP/Subnet Provision Rules
Configure and get details of AP IP/Subnet Provision Rules
AP Model Provision RulesConfigure and get details of AP model Provision Rules
Configure and get details of AP model Provision Rules
Models
BackgroundTaskStatusResponse{
}
| message | string example: Syncing task |
| success | string example: false |
| taskstatus | {...} |
#/definitions/SwapAPSwapAP{
}
| controllerip | string example: 10.157.7.190 |
| mac | string example: 94:F6:65:20:D5:10 |
| swapinmac | string example: 94:F6:65:20:D5:10 |
| apname | string example: RuckusAP |
#/definitions/SwapAPResponseSwapAPResponse{
}
| message | string example: AP Swapped successfully |
| success | string example: false |
SearchTaskResponse{
}
| message | string example: Search process started successfully, Search process will be completed in the background, you can use task Id to get the search result |
| success | string example: false |
| taskstatus | string example: Running |
| data | {...} |
SearchResponse{
}
| message | string example: Search process started successfully, Search process will be completed in the background, you can use task Id to get the search result |
| success | string example: false |
| taskId | string example: 5cf102f783455f4cec86a54b |
#/definitions/EditAPModelEditAPModel{
}
| apmodelname | string example: R600 |
| clustername | string example: RuckusOffice50 |
| id | string example: 5cefb6155509791c43dadcc8 |
| zonename | string example: charterdemo |
#/definitions/AddAPModelAddAPModel{
}
| clustername | string example: RuckusOffice45 |
| zonename | string example: testsubdomainzone |
| apmodelname | string example: C500 |
#/definitions/DeleteAPModelResponseDeleteAPModelResponse{
}
| message | string example: AP model name already exists |
| success | string example: false |
#/definitions/EditAPModelResponseEditAPModelResponse{
}
| message | string example: AP model name already exists |
| success | string example: false |
#/definitions/AddAPModelResponseAddAPModelResponse{
}
| message | string example: AP model name already exists |
| success | string example: false |
#/definitions/GetAPModelsResponseGetAPModelsResponse{
}
| totalCount | integer example: 1 |
| hasMore | string example: true |
| list | {...} |
#/definitions/UserAuthUserAuth{
}
| username | string example: admin |
| password | string example: admin |
#/definitions/APAP{
}
| apserial* | integer($int64) example: 450000000999 |
| apname* | string example: Test45_999 |
| zonename* | string example: Staging Zone |
| clusterid* | string example: 5a5de6275400fa0d0cf07eda |
| mac* | string example: F0:B0:52:20:8C:E0 |
| zoneid* | string default: 8af923cf-6457-4f45-acf8-490ccba5a519 |
| connectionstate | string example: ProvisionedEnum: Array [ 5 ] |
| lastsynchtime | string example: 2018-01-16T11:46:49.629Z |
| last_contacted | string example: 2018-01-16T11:46:49.629Z |
| last_modified | string example: 2018-01-16T11:46:49.629Z |
| username* | string example: admin |
#/definitions/AddAPAddAP{
}
| apserial* | integer($int64) example: 450000000999 |
| clusterip | string example: 10.150.84.45 |
| apname | string example: TestAP |
| zonename | string example: TestZone |
#/definitions/AddAPResponseAddAPResponse{
}
| success | string example: true |
| message | string example: AP added successfully |
#/definitions/MoveAPMoveAP{
}
| apserial | integer($int64) example: 450000000999 |
| newapname | string example: TestAP |
| newzonename | string example: TestZone |
| newclusterip | string example: 10.150.84.45 |
#/definitions/MoveAPResponseMoveAPResponse{
}
| success | string example: true |
| message | string example: AP moved successfully |
#/definitions/DeleteAPResponseDeleteAPResponse{
}
| success | string example: true |
| message | string example: AP deleted successfully |
#/definitions/BulkAPUploadBulkAPUpload{
}
| success | string example: true |
| message | string example: 5 APs added, 0 APs failed |
| task | string example: true |
| id | string example: 5cf4d3b037d33615d07f5c79 |
#/definitions/ImportClusterAPResponseImportClusterAPResponse{
}
| success | string example: true |
| message | string example: Cluster APs data imported successfully |
#/definitions/DeleteClusterAPResponseDeleteClusterAPResponse{
}
| success | string example: true |
| message | string example: 5 APs deleted, 0 APs failed |
#/definitions/AddClusterAddCluster{
}
| ip* | string($10.150.84.45) example: 10.150.84.45 |
| name* | string example: RuckusOffice1 |
| loginid* | string example: admin |
| password* | string example: myap |
#/definitions/AddClusterResponseAddClusterResponse{
}
| success | string example: true |
| message | string example: Add Cluster process started successfully, Use task Id (5cf62f1e436e8a23f4fffcca) to get its status |
| id | string example: 5cf62f1e436e8a23f4fffcca |
| task | string example: true |
#/definitions/UpdateClusterResponseUpdateClusterResponse{
}
| success | string example: true |
| message | string example: Update Cluster process started successfully, Use task Id (5cf62f89436e8a23f4fffccd) to get its status |
| id | string example: 5cf62f89436e8a23f4fffccd |
| task | string example: true |
#/definitions/DeleteClusterDeleteCluster{
}
| success | string example: true |
| message | string example: Delete Cluster process started successfully, Use task Id (5cf62fca436e8a23f4fffccf) to get its status |
| id | string example: 5cf62fca436e8a23f4fffccf |
| task | string example: true |
#/definitions/ImportAPsClusterImportAPsCluster{
}
| clustername | string example: RuckusOffice45 |
| importaps | string example: true |
#/definitions/ClusterCluster{
}
| ip* | string example: 10.150.84.45 |
| name* | string example: RuckusOffice1 |
| loginid* | string example: admin |
| password* | string example: myap |
| tag | string example: myap |
| managementips | [...] |
| controllerips | [...] |
| zones | [...] |
| numberofaps | string example: 2 |
| defaultcluster | string example: false |
| status | integer example: 1Enum: Array [ 2 ] |
| stats | string example: true |
| lastsynchtime | string example: 2018-01-16T11:46:49.629Z |
| creationtime | string example: 2018-01-16T11:46:49.629Z |
| last_modified | string example: 2018-01-16T11:46:49.629Z |
| username* | string example: admin |
#/definitions/EditLogsConfigurationEditLogsConfiguration{
}
| filelogseverity* | string example: debug |
| filelogssize* | string example: 5 |
| maxlogfiles* | string example: 10 |
#/definitions/ResLogsConfigurationResLogsConfiguration{
}
| success | string example: true |
| message | string example: Application logs settings updated successfully |
applicationLogsList{
}
| type | string example: web-ui |
| logstype | string example: Web Logs |
| files | {...} |
#/definitions/EditBackProcessConfigurationEditBackProcessConfiguration{
}
| enabled* | boolean example: true |
| frequency* | string example: 15min |
#/definitions/ResBackProcessConfigurationResBackProcessConfiguration{
}
| success | string example: true |
| message | string example: User back process settings info updated successfully |
#/definitions/ResConfigExportResConfigExport{
}
| success | string example: true |
| message | string example: DB Dump completed successfully |
#/definitions/alarmSettingsalarmSettings{
}
| code* | string example: 100 |
| description* | string example: Connection between ND and wireless controller cluster is offline |
| threshold* | string example: 80 |
| isenabled* | boolean example: true |
| creationtime* | string($date-time) example: 2018-01-16T11:46:49.629Z |
| username* | string example: admin |
EditAlarmSettings{
}
| connectionOffline* | boolean example: true |
| connectionFlagged* | boolean example: true |
| clusterStateOffline* | boolean example: true |
| clusterStateFlagged* | boolean example: true |
| cpStateOffline* | boolean example: true |
| cpStateFlagged* | boolean example: true |
| dpStateOffline* | boolean example: true |
| dpStateFlagged* | boolean example: true |
| apStateOffline* | boolean example: true |
| apStateOfflineThreshold* | integer example: 80 |
| apStateFlagged* | boolean example: true |
| apStateFlaggedThreshold* | integer example: 80 |
| apLicense* | boolean example: true |
| apLicenseThreshold* | integer example: 90 |
| diskUsage* | boolean example: true |
| diskUsageThreshold* | integer example: 80 |
| configSyncCompletion* | boolean example: true |
#/definitions/alarmListalarmList{
}
| severity* | string example: major |
| code* | string example: 100 |
| message* | string example: The percentage (50%) of offline access points (1 offline out of 2 total) has exceeded the defined threshold on wireless controller cluster (RuckusOffice50) |
| clusterId* | string example: 5b517a565ccdfb458c092ad4 |
| clusterName | string example: 5b517a565ccdfb458c092ad4 |
| cpClusterKey* | string example: 5b517a565ccdfb458c092ad4 |
| cpClusterName | string example: 5b517a565ccdfb458c092ad4 |
| dpClusterKey* | string example: 5b517a565ccdfb458c092ad4 |
| dpClusterName | string example: 5b517a565ccdfb458c092ad4 |
| cleared* | string example: 1 |
| clearedAt* | string example: 2018-01-16T11:46:49.629Z |
| createdAt* | string($date-time) example: 2018-01-16T11:46:49.629Z |
| username* | string example: admin |
#/definitions/emailSettingListemailSettingList{
}
| host* | string example: 10.150.84.45 |
| port* | string example: 100 |
| secure* | boolean example: true |
| service* | string example: Gmail |
| user* | string example: [email protected] |
| password* | string example: sombir@123 |
| sendername* | string example: Ruckus Admin |
| toaddresses* | string example: [email protected] |
| isenabled* | boolean example: true |
| creationtime* | string($date-time) example: 2018-01-16T11:46:49.629Z |
| last_modified* | string($date-time) example: 2018-01-16T11:46:49.629Z |
| username* | string example: admin |
EditEmailSettings{
}
| host* | string example: 10.150.84.47 |
| port* | string example: 100 |
| secure* | boolean example: true |
| service* | string example: Gmail |
| user* | string example: [email protected] |
| password* | string example: sombir@123 |
| sendername* | string example: Ruckus Admin |
| toaddresses* | string example: [email protected] |
| isenabled* | boolean example: true |
ResEditAlarmSettings{
}
| success | string example: true |
| message | string example: Alarms settings updated successfully |
ResEditEmailSettings{
}
| success | string example: true |
| message | string example: Email settings updated successfully |
UploadAPstring
#/definitions/regionsregions{
}
| list | [...] |
#/definitions/subnetsResponsesubnetsResponse{
}
| totalCount | integer |
| hasMore | boolean |
| list | [...] |
#/definitions/AddProvisionRuleAddProvisionRule{
}
| regionname* | string example: Test1 |
| iprange* | string example: 10.150.84.45 |
| subnetmask* | string example: 32 |
| clustername* | string example: RuckusOffice45 |
| zonename* | string example: TestZone |
| iprangetype* | string example: ipv4 |
| apmodels | [...] |
#/definitions/AddProvisionRuleResponseAddProvisionRuleResponse{
}
| success | string example: true |
| message | string example: Registration rule added successfully |
| id | string example: 60c17c2cc29250daa20768df |
#/definitions/UpdateProvisionRuleResponseUpdateProvisionRuleResponse{
}
| success | string example: true |
| message | string example: Registration rule updated successfully |
#/definitions/DeleteProvisionRuleResponseDeleteProvisionRuleResponse{
}
| success | string example: true |
| message | string example: Registration rule Deleted successfully |