What's New

PUT /certificateTemplates/{templateId}/policySets/{policySetId}

Update Policy Set for a Template

DELETE /certificateTemplates/{templateId}/policySets/{policySetId}

Remove Policy Set from a Template

GET /certificates/{certId}

Get Specific Certificate

POST /certificates/{certId}

Download the Private KEY of Certificate

PATCH /certificates/{certId}

Update the Certificate

POST /certificates/query

Search for Certificates Matching Search String in Paged Result

POST /certificates

Upload the Certificate

GET /certificateTemplates/{templateId}/scepKeys

Get Simple Certificate Enrollment Protocol of Template

POST /certificateTemplates/{templateId}/scepKeys

Create Simple Certificate Enrollment Protocol for Template

GET /certificateTemplates/{templateId}/notifications

Get Notifications of Template

POST /certificateTemplates/{templateId}/notifications

Create Notification for Template

GET /certificateTemplates/{templateId}/msiPackages

Get Microsoft Software Installer Packages of Template

POST /certificateTemplates/{templateId}/msiPackages

Create Microsoft Software Installer Package for Template

POST /certificateTemplates/{templateId}/identities/{identityId}/certificates

Generate Certificate to a Specific Identity

POST /certificateTemplates/{templateId}/identities/{identityId}/certificates/query

Search for Certificates Associated with Identity in Paged Result

POST /certificateTemplates/{templateId}/certificates

Generate Certificate

GET /certificateTemplates/{templateId}/certificates/{certId}

Get Specific Certificate

POST /certificateTemplates/{templateId}/certificates/{certId}

Download the Private KEY of Certificate

PATCH /certificateTemplates/{templateId}/certificates/{certId}

Update the Certificate

POST /certificateTemplates/{templateId}/certificates/query

Search for Certificates in Specific Template Matching Search String in Paged Result

POST /certificateTemplates/query

Search for Certificate Templates Matching Search String in Paged Result

POST /certificateTemplates/certificates/query

Search for Certificates Matching Search String in Paged Result

POST /certificateAuthorities

Create New Certificate Authority

GET /certificateAuthorities/{caId}

Get Specific Certificate Authority

POST /certificateAuthorities/{caId}

Download the Private KEY of Certificate Authority

DELETE /certificateAuthorities/{caId}

Delete the Certificate Authority

PATCH /certificateAuthorities/{caId}

Update the Certificate Authority

POST /certificateAuthorities/{caId}/templates

Create New Certificate Template Belonging to a Specific Certificate Authority

POST /certificateAuthorities/{caId}/templates/query

Search for Templates Belonging to a Specific Certificate Authority That Match Search String in Paged Result

POST /certificateAuthorities/{caId}/subCas

Create New Sub Certificate Authority

POST /certificateAuthorities/{caId}/subCas/query

Search for Sub Certificate Authorities Matching Search String in Paged Result

POST /certificateAuthorities/{caId}/certificates/query

Search for Certificates Issued by Specific Certificate Authority Matching Search String in Paged Result

POST /certificateAuthorities/{caId}/certificates

Create Certificate

POST /certificateAuthorities/{caId}/privateKeys

Upload the Certificate Authority Private KEY

DELETE /certificateAuthorities/{caId}/privateKeys

Delete the Certificate Authority Private KEY

POST /certificateAuthorities/query

Search for Certificate Authorities Matching Search String in Paged Result

GET /certificateTemplates/{templateId}

Get Specific Certificate Template

DELETE /certificateTemplates/{templateId}

Delete the Certificate Template

PATCH /certificateTemplates/{templateId}

Update the Certificate Template

GET /certificateTemplates/{templateId}/scepKeys/{scepKeyId}

Get Specific Simple Certificate Enrollment Protocol of Template

DELETE /certificateTemplates/{templateId}/scepKeys/{scepKeyId}

Delete the Simple Certificate Enrollment Protocol

PATCH /certificateTemplates/{templateId}/scepKeys/{scepKeyId}

Update the Simple Certificate Enrollment Protocol of Template

GET /certificateTemplates/{templateId}/notifications/{notificationId}

Get Specific Notification

DELETE /certificateTemplates/{templateId}/notifications/{notificationId}

Delete the Notification

PATCH /certificateTemplates/{templateId}/notifications/{notificationId}

Update the Notification of Template

GET /certificateTemplates/{templateId}/msiPackages/{msiPackageId}

Get Specific Microsoft Software Installer Package

DELETE /certificateTemplates/{templateId}/msiPackages/{msiPackageId}

Delete the Microsoft Software Installer Package

PATCH /certificateTemplates/{templateId}/msiPackages/{msiPackageId}

Update the Microsoft Software Installer Package of Template

GET /certificateTemplates/{templateId}/certificates/{certId}/chains

Download Issued Certificate Chain

GET /certificateAuthorities/{caId}/chains

Download the Certificate Chain of Certificate Authority

GET /edgeFirewallServices/{firewallId}

Get Firewall

PUT /edgeFirewallServices/{firewallId}

Update Firewall

DELETE /edgeFirewallServices/{firewallId}

Delete Firewall

PATCH /edgeFirewallServices/{firewallId}

Partial Update Firewall

GET /edgeDhcpServices/{dhcpId}

Get DHCP

PUT /edgeDhcpServices/{dhcpId}

Update DHCP

DELETE /edgeDhcpServices/{dhcpId}

Delete DHCP

PATCH /edgeDhcpServices/{dhcpId}

Patch DHCP

GET /edgeFirewallServices

Get Firewalls

POST /edgeFirewallServices

Create Firewall

DELETE /edgeFirewallServices

Delete Firewalls

POST /edgeDhcpServices

Create DHCP

DELETE /edgeDhcpServices

Delete DHCPs

GET /edgeDhcpServices/edgeDhcpRelationships/{edgeId}

Get DHCP by Edge ID

GET /edgeDhcpServices/dhcps

Get DHCPs

PUT /dpskServices/{poolId}/policySets/{policySetId}

Update Policy Set for a DPSK Pool

DELETE /dpskServices/{poolId}/policySets/{policySetId}

Remove Policy Set from a DPSK Pool

POST /dpskServices/{poolId}/passphrases/query/csvFiles

DPSK Passphrase to CSV

POST /dpskServices/{poolId}/passphrases/csvFiles

Import Passphrase from CSV

GET /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

Get Link Aggregation Group

PUT /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

Update Link Aggregation Group

DELETE /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

Delete Link Aggregation Group

PATCH /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}

Partial Update Link Aggregation Group

GET /edgeSdLanServices/{sdLanServiceId}

Get SD-LAN Service

PUT /edgeSdLanServices/{sdLanServiceId}

Update SD-LAN Service

DELETE /edgeSdLanServices/{sdLanServiceId}

Delete SD-LAN Service

PATCH /edgeSdLanServices/{sdLanServiceId}

Partial SD-LAN Service

PUT /edgeSdLanServices/{sdLanServiceId}/wifiNetworks/{wifiNetworkId}

Activate Network in SD-LAN

DELETE /edgeSdLanServices/{sdLanServiceId}/wifiNetworks/{wifiNetworkId}

Deactivate Network in SD-LAN

PUT /edgeSdLanServices/{sdLanServiceId}/guestSettings/venues/{venueId}/edgeClusters/{edgeClusterId}

Activate Guest SmartEdge Cluster

DELETE /edgeSdLanServices/{sdLanServiceId}/guestSettings/venues/{venueId}/edgeClusters/{edgeClusterId}

Deactivate Guest SmartEdge Cluster

PUT /edgeSdLanServices/{sdLanServiceId}/guestSettings/tunnelProfiles/{tunnelProfileId}

Activate Guest Tunnel

DELETE /edgeSdLanServices/{sdLanServiceId}/guestSettings/tunnelProfiles/{tunnelProfileId}

Deactivate Guest Tunnel

GET /venues/{venueId}/edgeClusters

Get SmartEdge Clusters

POST /venues/{venueId}/edgeClusters

Create SmartEdge Cluster

POST /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags

Create Link Aggregation Group

POST /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces

Create Sub-Interface

POST /venues/{venueId}/edgeClusters/{clusterId}/edges

Add Device

GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces

Get Sub-Interfaces

POST /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces

Create Multiple Sub-Interfaces

POST /edgeSdLanServices

Create SD-LAN Service

GET /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

Get Sub-Interface

DELETE /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

Delete Sub-Interface

PATCH /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

Partial Update Sub-Interface

GET /venues/{venueId}/edgeClusters/{clusterId}

Get SmartEdge Cluster

DELETE /venues/{venueId}/edgeClusters/{clusterId}

Delete a SmartEdge Cluster

PATCH /venues/{venueId}/edgeClusters/{clusterId}

Update SmartEdge Cluster

GET /venues/{venueId}/edgeClusters/{clusterId}/networkSettings

Get SmartEdge Cluster Network

PATCH /venues/{venueId}/edgeClusters/{clusterId}/networkSettings

Update SmartEdge Cluster Network

GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}

Get Device

DELETE /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}

Delete Device

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}

Update Device

GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs

Get Static Route Configuration

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs

Update Static Route Configuration

DELETE /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}

Delete Sub-Interface

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}

Update Sub-Interface

GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs

Get Physical Port Configuration

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs

Update Physical Port Configuration

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/hostDetails

Trigger EDGE Action

GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers

Get DNS Configuration

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers

Update DNS Configuration

GET /edgeSdLanServices/{sdLanServiceId}/guestSettings

Get Guest Settings

PATCH /edgeSdLanServices/{sdLanServiceId}/guestSettings

Update Guest Settings

POST /dpskServices/{poolId}/passphrases/{passphraseId}/devices

Create Devices for a Specific Passphrase

What's Deleted

POST /token

Request Authentication

PATCH /dpskServices/{poolId}/passphrases/{passphraseId}/devices

Update Devices for Passphrase

What's Deprecated

GET /dpskServices

Get DPSK Pools

What's Changed

GET /dpskServices/{poolId}/passphrases/{passphraseId}/devices

Get Devices for a Specific Passphrase

Return Type:

Changed response : 200 OK

Get Passphrase Devices

• New content type : application/vnd.ruckus.v2+json

• New content type : application/vnd.ruckus.v1.1+json

• Changed content type : application/json

Changed response : 404 Not Found

DPSK passphrase not found

• Deleted content type : application/json

DELETE /dpskServices/{poolId}/passphrases/{passphraseId}/devices

Delete Devices Associated with a Specific Passphrase

Parameters:

Changed: passphraseId in path

DPSK passphrase ID

Changed: poolId in path

DPSK pool ID

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Return Type:

Deleted response : 404 Not Found

DPSK passphrase not found

Changed response : 202 Accepted

The request to delete devices associated with the specified passphrase has been accepted.

• New content type : application/vnd.ruckus.v2+json

• New content type : application/vnd.ruckus.v1.1+json

• Changed content type : application/json

PATCH /dpskServices/{poolId}/passphrases/{id}

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

• Added property passphrase (string)

  The actual passphrase.

• Added property username (string)

  Username for the passphrase.

• Added property vlanId (integer)

  VLAN associated with passphrase.

• Added property numberOfDevices (integer)

  Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.

• Added property expirationDate (string)

  Expiration date of passphrase.

• Added property email (string)

  Email associated with passphrase.

• Added property phoneNumber (string)

  Phone associated with passphrase.

• Added property revocationReason (string)

  Reason for revocation of passphrase.

Return Type:

New response : 202 Accepted

The passphrase update request is in progress

Deleted response : 200 OK

DPSK passphrase updated

Deleted response : 404 Not Found

DPSK passphrase not found

GET /dpskServices/{poolId}/passphrases/{id}

Return Type:

Changed response : 404 Not Found

DPSK passphrase not found

• Deleted content type : application/json

Changed response : 200 OK

DPSK passphrase

• New content type : application/vnd.ruckus.v2+json

• New content type : application/vnd.ruckus.v1.1+json

• Changed content type : application/json

  • Added property lastModifiedDate (string)

  • Added property devices (array)

    The devices configured or connected to the passphrase.

    Items (object):

    The devices configured or connected to the passphrase.

    • Property mac (string)

    • Property lastConnectedNetwork (string)

    • Property lastConnectedNetworkId (string)

    • Property lastConnectedTime (string)

    • Property deviceConnectivity (string)

    • Property devicePassphrase (string)

    • Property lastConnected (string)

    • Property online (boolean)

  • Added property isReferenced (boolean)

    If this entity is referenced by an identity and cannot be deleted.

  • Deleted property mac (string)

    Mac address of client.

  • Deleted property lastUpdationDate (string)

  • Deleted property identityId (string)

    Associated identity of passphrase.

  • Deleted property requestId (string)

    Returned request ID after processing.

  • Changed property id (string)

  • Changed property numberOfDevices (integer)

    Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.

  • Changed property email (string)

    Email associated with passphrase.

  • Changed property revocationDate (string)

  • Changed property revocationReason (string)

    Reason for revocation of passphrase.

PUT /dpskServices/{poolId}/passphrases/{id}

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

• Deleted property mac (string)

  Mac address of client.

• Deleted property lastUpdationDate (string)

• Changed property id (string)

• Changed property numberOfDevices (integer)

  Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.

• Changed property email (string)

  Email associated with passphrase.

• Changed property revocationDate (string)

• Changed property revocationReason (string)

  Reason for revocation of passphrase.

Return Type:

New response : 202 Accepted

The passphrase update request is in progress

Deleted response : 200 OK

DPSK passphrase updated

Deleted response : 404 Not Found

DPSK passphrase not found

DELETE /dpskServices/{poolId}

Delete the DPSK Pool

Return Type:

New response : 202 Accepted

The delete request has been accepted and is in progress.

Deleted response : 200 OK

DPSK pool deleted

PATCH /dpskServices/{poolId}

Update the DPSK Pool

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

New required properties:

• name
• passphraseFormat
• passphraseLength

• Added property name (string)

• Added property passphraseFormat (string)

  Passphrase format.

  Enum values:

  • MOST_SECURED
  • KEYBOARD_FRIENDLY
  • NUMBERS_ONLY

• Added property passphraseLength (integer)

  Generated passphrase length.

• Added property policyDefaultAccess (boolean)

• Added property deviceCountLimit (integer)

• Added property expirationType (string)

  Expiration date rule.

  Enum values:

  • SPECIFIED_DATE
  • HOURS_AFTER_TIME
  • DAYS_AFTER_TIME
  • WEEKS_AFTER_TIME
  • MONTHS_AFTER_TIME
  • YEARS_AFTER_TIME

• Added property expirationOffset (integer)

  Date of expiration offset.

• Added property expirationDate (string)

  Expiration date of pool.

Return Type:

New response : 202 Accepted

The update request has been accepted and is in progress.

Deleted response : 200 OK

DPSK pool updated

Deleted response : 404 Not Found

DPSK pool not found

GET /dpskServices/{poolId}

Get Specific DPSK Pool

Return Type:

Changed response : 404 Not Found

DPSK pool not found

• New content type : application/vnd.ruckus.v2+json

• New content type : application/vnd.ruckus.v1.1+json

Changed response : 200 OK

DPSK pool

• New content type : application/vnd.ruckus.v2+json

• New content type : application/vnd.ruckus.v1.1+json

• Changed content type : application/json

  • Added property createdDate (string)

  • Added property lastModifiedDate (string)

  • Added property isReferenced (boolean)

    If this entity is referenced by an identity group and cannot be deleted.

  • Added property networkCount (integer)

    Number of networks associated with this pool.

  • Deleted property networkIds (array)

  • Deleted property policySetId (string)

  • Deleted property identityId (string)

    Identifier of linked service.

  • Deleted property creationDate (string)

  • Deleted property lastUpdationDate (string)

  • Deleted property requestId (string)

  • Changed property id (string)

    Unique identifier for pool.

PUT /dpskServices/{poolId}

Update the DPSK Pool

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

• Deleted property networkIds (array)

• Deleted property policySetId (string)

• Deleted property identityId (string)

  Identifier of linked service.

• Deleted property creationDate (string)

• Deleted property lastUpdationDate (string)

• Deleted property requestId (string)

• Changed property id (string)

  Unique identifier for pool.

Return Type:

New response : 202 Accepted

The update request has been accepted and is in progress.

Deleted response : 200 OK

DPSK pool updated

Deleted response : 404 Not Found

DPSK pool not found

POST /dpskServices/{poolId}/passphrases/query

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

• Changed property filters (object)

  • Deleted property includeExpired (array)

Return Type:

Changed response : 200 OK

Passphrases

• New content type : application/vnd.ruckus.v2+json

• New content type : application/vnd.ruckus.v1.1+json

• Changed content type : application/json

  • Changed property data (array)

    Changed items (object):

    • Added property lastModifiedDate (string)

    • Added property devices (array)

      The devices configured or connected to the passphrase.

    • Added property isReferenced (boolean)

      If this entity is referenced by an identity and cannot be deleted.

    • Deleted property organization (string)

    • Deleted property mac (string)

    • Deleted property expiration (string)

    • Deleted property identityId (string)

    • Deleted property networkId (string)

    • Deleted property networkSsid (string)

    • Changed property id (string)

    • Changed property passphrase (string)

      The actual passphrase.

    • Changed property username (string)

      Username for the passphrase.

    • Changed property vlanId (integer)

      VLAN associated with passphrase.

    • Changed property numberOfDevices (integer)

      Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.

    • Changed property createdDate (string)

      Passphrase creation date.

    • Changed property expirationDate (string)

      Expiration date of passphrase.

    • Changed property email (string)

      Email associated with passphrase.

    • Changed property phoneNumber (string)

      Phone associated with passphrase.

    • Changed property revocationDate (string)

    • Changed property revocationReason (string)

      Reason for revocation of passphrase.

DELETE /dpskServices/{poolId}/passphrases

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

Return Type:

New response : 202 Accepted

The passphrase(s) delete request is in progress

Deleted response : 200 OK

The DPSK passphrases were deleted

POST /dpskServices/{poolId}/passphrases

Create DPSK Passphrase

Parameters:

Deleted: usernamePrefix in query

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Deleted content type : multipart/form-data

Changed content type : application/json

• Added property vxlanId (integer)

• Deleted property override (boolean)

  Override true replaces value

• Deleted property networkId (string)

  The WLAN for passphrase.

• Changed property passphrase (string)

  Actual passphrase.

• Changed property numberOfDevices (integer)

  Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.

• Changed property email (string)

  The email for passphrase.

Return Type:

New response : 202 Accepted

Create DPSK passphrase(s) accepted

Deleted response : 200 OK

Passphrases

Deleted response : 201 Created

DPSK passphrase(s) created

Changed response : 400 Bad Request

Invalid content supplied

• New content type : application/vnd.ruckus.v2+json

• New content type : application/vnd.ruckus.v1.1+json

PATCH /dpskServices/{poolId}/passphrases

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

• Changed property changes (object)

  Changes to be applied to the passphrases.

  • Added property passphrase (string)

    The actual passphrase.

  • Added property username (string)

    Username for the passphrase.

  • Added property vlanId (integer)

    VLAN associated with passphrase.

  • Added property numberOfDevices (integer)

    Number of devices. Must be between 1 and 50. Inputs outside this range will be adjusted.

  • Added property expirationDate (string)

    Expiration date of passphrase.

  • Added property email (string)

    Email associated with passphrase.

  • Added property phoneNumber (string)

    Phone associated with passphrase.

  • Added property revocationReason (string)

    Reason for revocation of passphrase.

Return Type:

New response : 202 Accepted

DPSK passphrases updated

Deleted response : 200 OK

DPSK passphrases updated

Deleted response : 404 Not Found

DPSK passphrases not found

GET /dpskServices/{poolId}/passphrases

Parameters:

Deleted: timezone in query

If specified, the timezone will be used for date values. Default value is UTC.

Deleted: date-format in query

Format will be applied for date values. Default value is "dd/MM/yyyy HH:mm"

Return Type:

Deleted response : 400 Bad Request

Invalid timezone or date format supplied

Changed response : 200 OK

Passphrases

• New content type : application/vnd.ruckus.v2+json

• New content type : application/vnd.ruckus.v1.1+json

• Deleted content type : text/csv

POST /dpskServices/query

Search for DPSK Pools Matching Search String in Paged Result

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Return Type:

Changed response : 200 OK

DPSK pools

• New content type : application/vnd.ruckus.v2+json

• New content type : application/vnd.ruckus.v1.1+json

• Changed content type : application/json

  • Changed property data (array)

    DPSK services in page.

    Changed items (object):

    • Added property createdDate (string)

    • Added property lastModifiedDate (string)

    • Added property isReferenced (boolean)

      If this entity is referenced by an identity group and cannot be deleted.

    • Added property networkCount (integer)

      Number of networks associated with this pool.

    • Deleted property networkIds (array)

    • Deleted property policySetId (string)

    • Deleted property identityId (string)

      Identifier of linked service.

    • Deleted property creationDate (string)

    • Deleted property lastUpdationDate (string)

    • Deleted property requestId (string)

    • Changed property id (string)

      Unique identifier for pool.

POST /dpskServices

Create New DPSK Pool

Request:

New content type : application/vnd.ruckus.v2+json

New content type : application/vnd.ruckus.v1+json

New content type : application/vnd.ruckus.v1.1+json

Changed content type : application/json

• Deleted property networkIds (array)

• Deleted property policySetId (string)

• Deleted property identityId (string)

  Identifier of linked service.

• Deleted property creationDate (string)

• Deleted property lastUpdationDate (string)

• Deleted property requestId (string)

• Changed property id (string)

  Unique identifier for pool.

Return Type:

New response : 202 Accepted

DPSK pool created

Deleted response : 201 Created

DPSK pool created

Changed response : 400 Bad Request

Invalid pool content

• New content type : application/vnd.ruckus.v2+json

• New content type : application/vnd.ruckus.v1.1+json

GET /dpskServices

Get DPSK Pools

Return Type:

Changed response : 200 OK

DPSK pools

• New content type : application/vnd.ruckus.v2+json

• New content type : application/vnd.ruckus.v1.1+json

GET /venues/{venueId}/propertyConfigs

Return Type:

Changed response : 200 OK

Ok

• Changed content type : application/hal+json

  New required properties:

  • personaGroupId
  • status
  • venueName

  • Added property venueId (string)

  • Added property venueName (string)

    Venue name.

  • Added property personaGroupId (string)

    Persona group identifier.

  • Added property residentPortalId (string)

    Resident portal identifier.

  • Added property status (string)

    Status of the property

    Enum values:

    • DISABLED
    • ENABLED

  • Added property unitConfig (object)

    Basic configuration on property units

    • Property type (string)

    • Property residentPortalAllowed (boolean)

      Allow resident portal.

    • Property residentApiAllowed (boolean)

      Allow resident portal API.

    • Property useMaxUnitCount (boolean)

      Restrict unit count.

    • Property maxUnitCount (integer)

      Maximum allowed unit count.

    • Property guestAllowed (boolean)

      Allow separate guest for the unit.

  • Added property communicationConfig (object)

    Configuration for communicating unit change events

    • Property type (string)

    • Property sendEmail (boolean)

      Enable email communication.

    • Property sendSms (boolean)

      Enable SMS communication.

    • Property unitAssignmentHtmlRegId (string)

      Unit assignment hyper text template.

    • Property unitAssignmentTextRegId (string)

      Unit assignment text template.

    • Property unitPassphraseChangeHtmlRegId (string)

      Unit passphrase change hyper text template.

    • Property unitPassphraseChangeTextRegId (string)

      Unit passphrase change text template.

    • Property guestPassphraseChangeHtmlRegId (string)

      Guest passphrase change hyper text template.

    • Property guestPassphraseChangeTextRegId (string)

      Guest passphrase change text template.

    • Property portalAccessResetHtmlRegId (string)

      Portal access reset hyper text template.

    • Property portalAccessResetTextRegId (string)

      Portal access reset text template.

    • Property portAssignmentHtmlRegId (string)

      Port assignment hyper text template.

    • Property portAssignmentTextRegId (string)

      Port assignment text template.

  • Deleted property guid (string)

    Property identifier.

  • Deleted property name (string)

    Property name.

  • Deleted property managementName (string)

    Property management name.

  • Deleted property managementPhone (string)

    Property management phone.

  • Deleted property managementEmail (string)

    Property management email.

  • Deleted property tenantPortalHelpText (string)

    Help text defined for the property.

  • Deleted property tenantPortalAnnouncements (string)

    Announcement defined for the property.

  • Deleted property allowSeparateGuestSecret (boolean)

    Allow separate secret for guest users.

  • Deleted property enforceMaxUnits (boolean)

    Restrict number of units.

  • Deleted property maxUnits (integer)

    Maximum units allowed.

  • Deleted property sendEmail (boolean)

    Send email notification.

  • Deleted property sendSms (boolean)

    Send SMS notification.

  • Deleted property ssids (array)

    List of networks.

  • Changed property address (string -> object)

    Venue address.

  • Changed property description (string)

Changed response : 400 Bad Request

Bad request

• Changed content type : application/hal+json

  New required properties:

  • personaGroupId
  • status
  • venueName

  • Added property venueId (string)

  • Added property venueName (string)

    Venue name.

  • Added property personaGroupId (string)

    Persona group identifier.

  • Added property residentPortalId (string)

    Resident portal identifier.

  • Added property status (string)

    Status of the property

  • Added property unitConfig (object)

    Basic configuration on property units

  • Added property communicationConfig (object)

    Configuration for communicating unit change events

  • Deleted property guid (string)

    Property identifier.

  • Deleted property name (string)

    Property name.

  • Deleted property managementName (string)

    Property management name.

  • Deleted property managementPhone (string)

    Property management phone.

  • Deleted property managementEmail (string)

    Property management email.

  • Deleted property tenantPortalHelpText (string)

    Help text defined for the property.

  • Deleted property tenantPortalAnnouncements (string)

    Announcement defined for the property.

  • Deleted property allowSeparateGuestSecret (boolean)

    Allow separate secret for guest users.

  • Deleted property enforceMaxUnits (boolean)

    Restrict number of units.

  • Deleted property maxUnits (integer)

    Maximum units allowed.

  • Deleted property sendEmail (boolean)

    Send email notification.

  • Deleted property sendSms (boolean)

    Send SMS notification.

  • Deleted property ssids (array)

    List of networks.

  • Changed property address (string -> object)

    Venue address.

  • Changed property description (string)

Changed response : 404 Not Found

Not found

• Changed content type : application/hal+json

  New required properties:

  • personaGroupId
  • status
  • venueName

  • Added property venueId (string)

  • Added property venueName (string)

    Venue name.

  • Added property personaGroupId (string)

    Persona group identifier.

  • Added property residentPortalId (string)

    Resident portal identifier.

  • Added property status (string)

    Status of the property

  • Added property unitConfig (object)

    Basic configuration on property units

  • Added property communicationConfig (object)

    Configuration for communicating unit change events

  • Deleted property guid (string)

    Property identifier.

  • Deleted property name (string)

    Property name.

  • Deleted property managementName (string)

    Property management name.

  • Deleted property managementPhone (string)

    Property management phone.

  • Deleted property managementEmail (string)

    Property management email.

  • Deleted property tenantPortalHelpText (string)

    Help text defined for the property.

  • Deleted property tenantPortalAnnouncements (string)

    Announcement defined for the property.

  • Deleted property allowSeparateGuestSecret (boolean)

    Allow separate secret for guest users.

  • Deleted property enforceMaxUnits (boolean)

    Restrict number of units.

  • Deleted property maxUnits (integer)

    Maximum units allowed.

  • Deleted property sendEmail (boolean)

    Send email notification.

  • Deleted property sendSms (boolean)

    Send SMS notification.

  • Deleted property ssids (array)

    List of networks.

  • Changed property address (string -> object)

    Venue address.

  • Changed property description (string)

Changed response : 500 Internal Server Error

Internal server error

• Changed content type : application/hal+json

  New required properties:

  • personaGroupId
  • status
  • venueName

  • Added property venueId (string)

  • Added property venueName (string)

    Venue name.

  • Added property personaGroupId (string)

    Persona group identifier.

  • Added property residentPortalId (string)

    Resident portal identifier.

  • Added property status (string)

    Status of the property

  • Added property unitConfig (object)

    Basic configuration on property units

  • Added property communicationConfig (object)

    Configuration for communicating unit change events

  • Deleted property guid (string)

    Property identifier.

  • Deleted property name (string)

    Property name.

  • Deleted property managementName (string)

    Property management name.

  • Deleted property managementPhone (string)

    Property management phone.

  • Deleted property managementEmail (string)

    Property management email.

  • Deleted property tenantPortalHelpText (string)

    Help text defined for the property.

  • Deleted property tenantPortalAnnouncements (string)

    Announcement defined for the property.

  • Deleted property allowSeparateGuestSecret (boolean)

    Allow separate secret for guest users.

  • Deleted property enforceMaxUnits (boolean)

    Restrict number of units.

  • Deleted property maxUnits (integer)

    Maximum units allowed.

  • Deleted property sendEmail (boolean)

    Send email notification.

  • Deleted property sendSms (boolean)

    Send SMS notification.

  • Deleted property ssids (array)

    List of networks.

  • Changed property address (string -> object)

    Venue address.

  • Changed property description (string)

POST /venues/propertyConfigs/query

Return Type:

Changed response : 400 Bad Request

Invalid query data supplied.

• Changed content type : application/hal+json

  • Changed property content (array)

    Changed items (object):

    New required properties:

    • personaGroupId
    • status
    • venueName

    • Added property venueId (string)

    • Added property venueName (string)

      Venue name.

    • Added property personaGroupId (string)

      Persona group identifier.

    • Added property residentPortalId (string)

      Resident portal identifier.

    • Added property status (string)

      Status of the property

    • Added property unitConfig (object)

      Basic configuration on property units

    • Added property communicationConfig (object)

      Configuration for communicating unit change events

    • Deleted property guid (string)

      Property identifier.

    • Deleted property name (string)

      Property name.

    • Deleted property managementName (string)

      Property management name.

    • Deleted property managementPhone (string)

      Property management phone.

    • Deleted property managementEmail (string)

      Property management email.

    • Deleted property tenantPortalHelpText (string)

      Help text defined for the property.

    • Deleted property tenantPortalAnnouncements (string)

      Announcement defined for the property.

    • Deleted property allowSeparateGuestSecret (boolean)

      Allow separate secret for guest users.

    • Deleted property enforceMaxUnits (boolean)

      Restrict number of units.

    • Deleted property maxUnits (integer)

      Maximum units allowed.

    • Deleted property sendEmail (boolean)

      Send email notification.

    • Deleted property sendSms (boolean)

      Send SMS notification.

    • Deleted property ssids (array)

      List of networks.

    • Changed property address (string -> object)

      Venue address.

    • Changed property description (string)

GET /venues/propertyConfigs

Return Type:

Changed response : 400 Bad Request

Invalid input supplied.

• Changed content type : */*

  • Changed property content (array)

    Changed items (object):

    New required properties:

    • personaGroupId
    • status
    • venueName

    • Added property venueId (string)

    • Added property venueName (string)

      Venue name.

    • Added property personaGroupId (string)

      Persona group identifier.

    • Added property residentPortalId (string)

      Resident portal identifier.

    • Added property status (string)

      Status of the property

    • Added property unitConfig (object)

      Basic configuration on property units

    • Added property communicationConfig (object)

      Configuration for communicating unit change events

    • Deleted property guid (string)

      Property identifier.

    • Deleted property name (string)

      Property name.

    • Deleted property managementName (string)

      Property management name.

    • Deleted property managementPhone (string)

      Property management phone.

    • Deleted property managementEmail (string)

      Property management email.

    • Deleted property tenantPortalHelpText (string)

      Help text defined for the property.

    • Deleted property tenantPortalAnnouncements (string)

      Announcement defined for the property.

    • Deleted property allowSeparateGuestSecret (boolean)

      Allow separate secret for guest users.

    • Deleted property enforceMaxUnits (boolean)

      Restrict number of units.

    • Deleted property maxUnits (integer)

      Maximum units allowed.

    • Deleted property sendEmail (boolean)

      Send email notification.

    • Deleted property sendSms (boolean)

      Send SMS notification.

    • Deleted property ssids (array)

      List of networks.

    • Changed property address (string -> object)

      Venue address.

    • Changed property description (string)