RuckusVirtualSmartZoneAPIClient

Ruckus - Virtual SmartZone - High Scale Public API Reference Guide

An API Client for the Virtual SmartZone - High Scale Public API Reference Guide to be able to easily use the API in a more standard way.

How to install

$ pip install RuckusVirtualSmartZoneAPIClient

Usage

The argument 'method' must be specify every time.

Default arguments and attributes

import RuckusVirtualSmartZoneAPIClient

client = RuckusVirtualSmartZoneAPIClient.Client(verify=False, warnings=False, api_version='v9_1')

client.get(url=None, method='', data=None, auth = None)

# client.headers
# client.base_url
# client.token
# client.auth
# client.server

Authentication

import RuckusVirtualSmartZoneAPIClient

client = RuckusVirtualSmartZoneAPIClient.Client()
client.connect(url='https://localhost:8443', username='admin', password='Admin123')

client.disconnect()

The first query

import RuckusVirtualSmartZoneAPIClient
import json

client = RuckusVirtualSmartZoneAPIClient.Client()
client.connect(url='https://localhost:8443', username='admin', password='Admin123')

response = client.get(method='/domains')
print(json.dumps(response.json(), indent=4))

client.disconnect()

Creating

import RuckusVirtualSmartZoneAPIClient
import json

client = RuckusVirtualSmartZoneAPIClient.Client()
client.connect(url='https://localhost:8443', username='admin', password='Admin123')

response = client.post(method='/domains', data={'name': 'TestDomain'})
domain_id = response.json()['id']
print(json.dumps(response.json(), indent=4)) # --> 201

client.disconnect()

Updating

import RuckusVirtualSmartZoneAPIClient
import json

client = RuckusVirtualSmartZoneAPIClient.Client()
client.connect(url='https://localhost:8443', username='admin', password='Admin123')

domain_id = '1234567890asdfg'
response = client.patch(method=f'/domains/{domain_id}', data={'description': 'I updated this description.'})
print(response.status_code) # --> 204

client.disconnect()

Deleting

import RuckusVirtualSmartZoneAPIClient

client = RuckusVirtualSmartZoneAPIClient.Client()
client.connect(url='https://localhost:8443', username='admin', password='Admin123')

domain_id = '1234567890asdfg'
response = client.delete(method=f'/domains/{domain_id}')
print(response.status_code) # --> 204

client.disconnect()