Skip to content
Overview/
/
/
Changed
Last updated

DPSK Service

POST /dpskServices/{poolId}/passphrases/csvFiles
Return Type:
  • Changed response : 200 OK

Passphrases

  • Changed content type : application/json

    • Added property id (object)

      Optional resource ID affected or created by the operation.

    • Added property requestId (object)

      Identifier for tracking the asynchronous request.

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

    • Added property id (object)

      Optional resource ID affected or created by the operation.

    • Added property requestId (object)

      Identifier for tracking the asynchronous request.

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

Update DPSK Pool Policy Set

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress

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

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

  • Changed content type : application/json

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

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

Remove DPSK Pool Policy Set

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress

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

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

  • Changed content type : application/json

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

DELETE /dpskServices/{poolId}
Return Type:
  • Changed response : 202 Accepted

The delete request has been accepted and is in progress.

  • Changed content type : application/json

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

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

GET /dpskServices/{poolId}
Return Type:
  • Changed response : 404 Not Found

DPSK pool not found

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

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

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

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

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed response : 200 OK

DPSK pool

  • Changed content type : application/json

    • Changed property createdDate (object)

      Creation date timestamp record.

    • Changed property deviceCountLimit (object)

      Maximum number of devices allowed per passphrase.

    • Changed property expirationType (object)

      Expiration date rule of pool.

    • Changed property isEnforced (object)

      Whether enforcement is enabled for this template.

    • Changed property lastModifiedDate (object)

      Last modification timestamp record.

    • Changed property name (object)

    • Changed property passphraseFormat (object)

      Format type of the passphrase.

    • Changed property passphraseLength (object)

      Minimum allowed length for the passphrase.

    • Changed property policyDefaultAccess (object)

      Default access if no policy rule matches.

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

    • Changed property createdDate (object)

      Creation date timestamp record.

    • Changed property deviceCountLimit (object)

      Maximum number of devices allowed per passphrase.

    • Changed property expirationType (object)

      Expiration date rule of pool.

    • Changed property isEnforced (object)

      Whether enforcement is enabled for this template.

    • Changed property lastModifiedDate (object)

      Last modification timestamp record.

    • Changed property name (object)

    • Changed property passphraseFormat (object)

      Format type of the passphrase.

    • Changed property passphraseLength (object)

      Minimum allowed length for the passphrase.

    • Changed property policyDefaultAccess (object)

      Default access if no policy rule matches.

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

    • Changed property createdDate (object)

      Creation date timestamp record.

    • Changed property deviceCountLimit (object)

      Maximum number of devices allowed per passphrase.

    • Changed property expirationType (object)

      Expiration date rule of pool.

    • Changed property isEnforced (object)

      Whether enforcement is enabled for this template.

    • Changed property lastModifiedDate (object)

      Last modification timestamp record.

    • Changed property name (object)

    • Changed property passphraseFormat (object)

      Format type of the passphrase.

    • Changed property passphraseLength (object)

      Minimum allowed length for the passphrase.

    • Changed property policyDefaultAccess (object)

      Default access if no policy rule matches.

PUT /dpskServices/{poolId}
Request:
  • Changed content type : application/json

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

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

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

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

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

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

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress.

  • Changed content type : application/json

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

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

PATCH /dpskServices/{poolId}
Request:
  • Changed content type : application/json

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

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

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

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

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

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

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress.

  • Changed content type : application/json

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

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

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

Get DPSK Passphrase

Return Type:
  • Changed response : 404 Not Found

DPSK passphrase not found

  • New content type : application/json

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

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

  • Changed response : 200 OK

DPSK passphrase

  • Changed content type : application/json

    • Changed property createdDate (object)

      Passphrase creation date record.

    • Changed property email (object)

      Email associated with passphrase.

    • Changed property lastModifiedDate (object)

      Last modification timestamp record.

    • Changed property passphrase (object)

      The actual passphrase value.

    • Changed property revocationDate (object)

      The date time that the PSK was revoked.

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

    • Changed property createdDate (object)

      Passphrase creation date record.

    • Changed property email (object)

      Email associated with passphrase.

    • Changed property lastModifiedDate (object)

      Last modification timestamp record.

    • Changed property passphrase (object)

      The actual passphrase value.

    • Changed property revocationDate (object)

      The date time that the PSK was revoked.

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

    • Changed property createdDate (object)

      Passphrase creation date record.

    • Changed property email (object)

      Email associated with passphrase.

    • Changed property lastModifiedDate (object)

      Last modification timestamp record.

    • Changed property passphrase (object)

      The actual passphrase value.

    • Changed property revocationDate (object)

      The date time that the PSK was revoked.

PUT /dpskServices/{poolId}/passphrases/{id}
Request:
  • Changed content type : application/json

  • Changed property email (object)

    Email associated with passphrase.

  • Changed property passphrase (object)

    The actual passphrase value.

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

  • Changed property email (object)

    Email associated with passphrase.

  • Changed property passphrase (object)

    The actual passphrase value.

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

  • Changed property email (object)

    Email associated with passphrase.

  • Changed property passphrase (object)

    The actual passphrase value.

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

  • Changed property email (object)

    Email associated with passphrase.

  • Changed property passphrase (object)

    The actual passphrase value.

Return Type:
  • Changed response : 202 Accepted

The passphrase update request is in progress

  • Changed content type : application/json

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

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

PATCH /dpskServices/{poolId}/passphrases/{id}
Request:
  • Changed content type : application/json

  • Changed property email (object)

    Email associated with passphrase.

  • Changed property passphrase (object)

    The actual passphrase value.

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

  • Changed property email (object)

    Email associated with passphrase.

  • Changed property passphrase (object)

    The actual passphrase value.

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

  • Changed property email (object)

    Email associated with passphrase.

  • Changed property passphrase (object)

    The actual passphrase value.

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

  • Changed property email (object)

    Email associated with passphrase.

  • Changed property passphrase (object)

    The actual passphrase value.

Return Type:
  • Changed response : 202 Accepted

The passphrase update request is in progress

  • Changed content type : application/json

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

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

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

Create Devices for Passphrase

Return Type:
  • Changed response : 202 Accepted

The request to create devices for the specified passphrase has been accepted.

  • Changed content type : application/json

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

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

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

Delete Devices Associated with Passphrase

Return Type:
  • Changed response : 202 Accepted

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

  • Changed content type : application/json

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

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

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

Get Passphrase Devices

Return Type:
  • Changed response : 404 Not Found

DPSK passphrase not found

  • New content type : application/json

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

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

  • Changed response : 200 OK

Get passphrase devices

  • Changed content type : application/json

    • Changed property deviceConnectivity (object)

      Device connectivity status indicator.

    • Changed property devicePassphrase (object)

      Passphrase used by the device.

    • Changed property lastConnected (object)

      Formatted timestamp of the last connection for display.

    • Changed property lastConnectedNetwork (object)

      SSID of the last network the device connected to.

    • Changed property lastConnectedNetworkId (object)

      ID of the last network the device connected to.

    • Changed property lastConnectedTime (object)

      Timestamp of the last connection in ISO format.

    • Changed property mac (object)

      Device MAC address record.

    • Changed property online (object)

      Previously used to determine device connection status. It is now recommended to use deviceConnectivity instead.

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

    • Changed property deviceConnectivity (object)

      Device connectivity status indicator.

    • Changed property devicePassphrase (object)

      Passphrase used by the device.

    • Changed property lastConnected (object)

      Formatted timestamp of the last connection for display.

    • Changed property lastConnectedNetwork (object)

      SSID of the last network the device connected to.

    • Changed property lastConnectedNetworkId (object)

      ID of the last network the device connected to.

    • Changed property lastConnectedTime (object)

      Timestamp of the last connection in ISO format.

    • Changed property mac (object)

      Device MAC address record.

    • Changed property online (object)

      Previously used to determine device connection status. It is now recommended to use deviceConnectivity instead.

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

    • Changed property deviceConnectivity (object)

      Device connectivity status indicator.

    • Changed property devicePassphrase (object)

      Passphrase used by the device.

    • Changed property lastConnected (object)

      Formatted timestamp of the last connection for display.

    • Changed property lastConnectedNetwork (object)

      SSID of the last network the device connected to.

    • Changed property lastConnectedNetworkId (object)

      ID of the last network the device connected to.

    • Changed property lastConnectedTime (object)

      Timestamp of the last connection in ISO format.

    • Changed property mac (object)

      Device MAC address record.

    • Changed property online (object)

      Previously used to determine device connection status. It is now recommended to use deviceConnectivity instead.

POST /identityGroups/{identityGroupId}/dpskServices
Request:
  • Changed content type : application/json

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

Return Type:
  • Changed response : 202 Accepted

DPSK pool created

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

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

  • Changed content type : application/json

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

  • Changed response : 400 Bad Request

Invalid pool content

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

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

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

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

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

POST /templates/dpskServices
Request:

New content type : application/json

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

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

Return Type:
  • Changed response : 202 Accepted

DPSK pool template created

  • New content type : application/json

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

  • Changed response : 400 Bad Request

Invalid pool content

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

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

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

DELETE /templates/dpskServices/{poolTemplateId}
Return Type:
  • Changed response : 202 Accepted

The delete request has been accepted and is in progress.

  • New content type : application/json

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

GET /templates/dpskServices/{poolTemplateId}
Return Type:
  • Changed response : 404 Not Found

DPSK pool template not found

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

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

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed response : 200 OK

DPSK pool template

  • New content type : application/json

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

    • Changed property createdDate (object)

      Creation date timestamp record.

    • Changed property deviceCountLimit (object)

      Maximum number of devices allowed per passphrase.

    • Changed property expirationType (object)

      Expiration date rule of pool.

    • Changed property isEnforced (object)

      Whether enforcement is enabled for this template.

    • Changed property lastModifiedDate (object)

      Last modification timestamp record.

    • Changed property name (object)

    • Changed property passphraseFormat (object)

      Format type of the passphrase.

    • Changed property passphraseLength (object)

      Minimum allowed length for the passphrase.

    • Changed property policyDefaultAccess (object)

      Default access if no policy rule matches.

PUT /templates/dpskServices/{poolTemplateId}
Request:

New content type : application/json

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

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress.

  • New content type : application/json

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

PATCH /templates/dpskServices/{poolTemplateId}
Request:

New content type : application/json

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

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress.

  • New content type : application/json

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

POST /templates/dpskServices/{poolTemplateId}/cloneSettings
Request:

New content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json
Return Type:
  • Changed response : 202 Accepted

DPSK pool template cloned

  • New content type : application/json

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

  • Changed response : 400 Bad Request

Invalid content

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

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

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

POST /templates/identityGroups/{identityGroupId}/dpskServices

Create Template with Identity Group

Request:

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

  • Changed content type : application/json

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

Return Type:
  • Changed response : 202 Accepted

DPSK pool created

  • Changed content type : application/json

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

  • Changed response : 400 Bad Request

Invalid pool content

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

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

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

GET /templates/wifiNetworks/{networkTemplateId}/dpskServices

Get Templates by Network Template

Return Type:
  • Changed response : 404 Not Found

DPSK pool not found

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

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

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed response : 200 OK

DPSK pool template

  • New content type : application/json

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

    • Changed property createdDate (object)

      Creation date timestamp record.

    • Changed property deviceCountLimit (object)

      Maximum number of devices allowed per passphrase.

    • Changed property expirationType (object)

      Expiration date rule of pool.

    • Changed property isEnforced (object)

      Whether enforcement is enabled for this template.

    • Changed property lastModifiedDate (object)

      Last modification timestamp record.

    • Changed property name (object)

    • Changed property passphraseFormat (object)

      Format type of the passphrase.

    • Changed property passphraseLength (object)

      Minimum allowed length for the passphrase.

    • Changed property policyDefaultAccess (object)

      Default access if no policy rule matches.

POST /dpskServices
Request:
  • Changed content type : application/json

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

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

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

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

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

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

  • Changed property deviceCountLimit (object)

    Maximum number of devices allowed per passphrase.

  • Changed property expirationType (object)

    Expiration date rule of pool.

  • Changed property name (object)

  • Changed property passphraseFormat (object)

    Format type of the passphrase.

  • Changed property passphraseLength (object)

    Minimum allowed length for the passphrase.

  • Changed property policyDefaultAccess (object)

    Default access if no policy rule matches.

Return Type:
  • Changed response : 202 Accepted

DPSK pool created

  • Changed content type : application/json

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

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

  • Changed response : 400 Bad Request

Invalid pool content

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

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

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

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

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

GET /dpskServices
Return Type:
  • Changed response : 200 OK

DPSK pools

  • Changed content type : application/json

    • Changed property content (object)

      List of items contained in the current page.

    • Changed property empty (object)

      Whether the page is empty.

    • Changed property first (object)

      Whether this is the first page.

    • Changed property last (object)

      Whether this is the last page.

    • Changed property number (object)

      Current page index starting from 0.

    • Changed property numberOfElements (object)

      Number of items present in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for a page request, including page size, page number, and sorting metadata.

      • Changed property pageNumber (object)

        Requested page index starting from 0.

      • Changed property pageSize (object)

        Number of items to include in each page.

      • Changed property paged (object)

        Whether paging is enabled.

      • Changed property unpaged (object)

        Whether paging is disabled.

    • Changed property sort (object)

      Sorting details applied to the query.

      • Changed property empty (object)

        Whether no sorting is applied.

      • Changed property sorted (object)

        Whether sorting is applied.

      • Changed property unsorted (object)

        Whether sorting is not applied.

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

    • Changed property content (object)

      List of items contained in the current page.

    • Changed property empty (object)

      Whether the page is empty.

    • Changed property first (object)

      Whether this is the first page.

    • Changed property last (object)

      Whether this is the last page.

    • Changed property number (object)

      Current page index starting from 0.

    • Changed property numberOfElements (object)

      Number of items present in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for a page request, including page size, page number, and sorting metadata.

      • Changed property pageNumber (object)

        Requested page index starting from 0.

      • Changed property pageSize (object)

        Number of items to include in each page.

      • Changed property paged (object)

        Whether paging is enabled.

      • Changed property unpaged (object)

        Whether paging is disabled.

    • Changed property sort (object)

      Sorting details applied to the query.

      • Changed property empty (object)

        Whether no sorting is applied.

      • Changed property sorted (object)

        Whether sorting is applied.

      • Changed property unsorted (object)

        Whether sorting is not applied.

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

    • Changed property content (object)

      List of items contained in the current page.

    • Changed property empty (object)

      Whether the page is empty.

    • Changed property first (object)

      Whether this is the first page.

    • Changed property last (object)

      Whether this is the last page.

    • Changed property number (object)

      Current page index starting from 0.

    • Changed property numberOfElements (object)

      Number of items present in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for a page request, including page size, page number, and sorting metadata.

      • Changed property pageNumber (object)

        Requested page index starting from 0.

      • Changed property pageSize (object)

        Number of items to include in each page.

      • Changed property paged (object)

        Whether paging is enabled.

      • Changed property unpaged (object)

        Whether paging is disabled.

    • Changed property sort (object)

      Sorting details applied to the query.

      • Changed property empty (object)

        Whether no sorting is applied.

      • Changed property sorted (object)

        Whether sorting is applied.

      • Changed property unsorted (object)

        Whether sorting is not applied.

POST /dpskServices/query

Search for DPSK Pools

Request:
  • Changed content type : application/json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property page (object)

    Page number, starting from index 0.

  • Changed property pageSize (object)

    Number of items per page.

  • Changed property searchString (object)

    Search string to match against the specified searchTargetFields.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort by.

  • Changed property sortOrder (object)

    Sort order: ASC for ascending, DESC for descending.

  • Changed property filters (object)

    Filter criteria for querying DPSK pools.

    • Changed property isEnforced (object)

      Whether enforcement is enabled for this instance.

    • Changed property passphraseFormat (object)

      An enum indicating the character set included in the passphrase. Supported values: NUMBERS_ONLY, KEYBOARD_FRIENDLY, MOST_SECURED.

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

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property page (object)

    Page number, starting from index 0.

  • Changed property pageSize (object)

    Number of items per page.

  • Changed property searchString (object)

    Search string to match against the specified searchTargetFields.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort by.

  • Changed property sortOrder (object)

    Sort order: ASC for ascending, DESC for descending.

  • Changed property filters (object)

    Filter criteria for querying DPSK pools.

    • Changed property isEnforced (object)

      Whether enforcement is enabled for this instance.

    • Changed property passphraseFormat (object)

      An enum indicating the character set included in the passphrase. Supported values: NUMBERS_ONLY, KEYBOARD_FRIENDLY, MOST_SECURED.

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

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property page (object)

    Page number, starting from index 0.

  • Changed property pageSize (object)

    Number of items per page.

  • Changed property searchString (object)

    Search string to match against the specified searchTargetFields.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort by.

  • Changed property sortOrder (object)

    Sort order: ASC for ascending, DESC for descending.

  • Changed property filters (object)

    Filter criteria for querying DPSK pools.

    • Changed property isEnforced (object)

      Whether enforcement is enabled for this instance.

    • Changed property passphraseFormat (object)

      An enum indicating the character set included in the passphrase. Supported values: NUMBERS_ONLY, KEYBOARD_FRIENDLY, MOST_SECURED.

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

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property page (object)

    Page number, starting from index 0.

  • Changed property pageSize (object)

    Number of items per page.

  • Changed property searchString (object)

    Search string to match against the specified searchTargetFields.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort by.

  • Changed property sortOrder (object)

    Sort order: ASC for ascending, DESC for descending.

  • Changed property filters (object)

    Filter criteria for querying DPSK pools.

    • Changed property isEnforced (object)

      Whether enforcement is enabled for this instance.

    • Changed property passphraseFormat (object)

      An enum indicating the character set included in the passphrase. Supported values: NUMBERS_ONLY, KEYBOARD_FRIENDLY, MOST_SECURED.

Return Type:
  • Changed response : 200 OK

DPSK pools

  • Changed content type : application/json

    • Changed property fields (object)

      List of field names that were requested in the query.

    • Changed property page (object)

      Current page number starting from 0.

    • Changed property totalCount (object)

      Total number of items matching the query criteria across all pages.

    • Changed property totalPages (object)

      Total number of pages available based on the pageSize and totalCount.

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

    • Changed property fields (object)

      List of field names that were requested in the query.

    • Changed property page (object)

      Current page number starting from 0.

    • Changed property totalCount (object)

      Total number of items matching the query criteria across all pages.

    • Changed property totalPages (object)

      Total number of pages available based on the pageSize and totalCount.

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

    • Changed property fields (object)

      List of field names that were requested in the query.

    • Changed property page (object)

      Current page number starting from 0.

    • Changed property totalCount (object)

      Total number of items matching the query criteria across all pages.

    • Changed property totalPages (object)

      Total number of pages available based on the pageSize and totalCount.

DELETE /dpskServices/{poolId}/passphrases
Return Type:
  • Changed response : 202 Accepted

The passphrase(s) delete request is in progress

  • Changed content type : application/json

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

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

POST /dpskServices/{poolId}/passphrases
Request:
  • Changed content type : application/json

  • Changed property email (object)

    The email for passphrase.

  • Changed property length (object)

    Length of the passphrase.

  • Changed property numberOfPassphrases (object)

    The number of PSK to be generated if passphrase is not provided.

  • Changed property passphrase (object)

    The actual passphrase value to be created.

  • Changed property vxlanId (object)

    The VNI to associate with this PSK.

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

  • Changed property email (object)

    The email for passphrase.

  • Changed property length (object)

    Length of the passphrase.

  • Changed property numberOfPassphrases (object)

    The number of PSK to be generated if passphrase is not provided.

  • Changed property passphrase (object)

    The actual passphrase value to be created.

  • Changed property vxlanId (object)

    The VNI to associate with this PSK.

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

  • Changed property email (object)

    The email for passphrase.

  • Changed property length (object)

    Length of the passphrase.

  • Changed property numberOfPassphrases (object)

    The number of PSK to be generated if passphrase is not provided.

  • Changed property passphrase (object)

    The actual passphrase value to be created.

  • Changed property vxlanId (object)

    The VNI to associate with this PSK.

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

  • Changed property email (object)

    The email for passphrase.

  • Changed property length (object)

    Length of the passphrase.

  • Changed property numberOfPassphrases (object)

    The number of PSK to be generated if passphrase is not provided.

  • Changed property passphrase (object)

    The actual passphrase value to be created.

  • Changed property vxlanId (object)

    The VNI to associate with this PSK.

Return Type:
  • Changed response : 202 Accepted

Create DPSK passphrase(s) accepted

  • Changed content type : application/json

    • Added property id (object)

      Optional resource ID affected or created by the operation.

    • Added property requestId (object)

      Identifier for tracking the asynchronous request.

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

    • Added property id (object)

      Optional resource ID affected or created by the operation.

    • Added property requestId (object)

      Identifier for tracking the asynchronous request.

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

    • Added property id (object)

      Optional resource ID affected or created by the operation.

    • Added property requestId (object)

      Identifier for tracking the asynchronous request.

  • Changed response : 400 Bad Request

Invalid content supplied

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

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

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

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

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

PATCH /dpskServices/{poolId}/passphrases
Request:
  • Changed content type : application/json

  • Changed property changes (object)

    Configuration and metadata of a DPSK passphrase.

    • Changed property email (object)

      Email associated with passphrase.

    • Changed property passphrase (object)

      The actual passphrase value.

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

  • Changed property changes (object)

    Configuration and metadata of a DPSK passphrase.

    • Changed property email (object)

      Email associated with passphrase.

    • Changed property passphrase (object)

      The actual passphrase value.

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

  • Changed property changes (object)

    Configuration and metadata of a DPSK passphrase.

    • Changed property email (object)

      Email associated with passphrase.

    • Changed property passphrase (object)

      The actual passphrase value.

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

  • Changed property changes (object)

    Configuration and metadata of a DPSK passphrase.

    • Changed property email (object)

      Email associated with passphrase.

    • Changed property passphrase (object)

      The actual passphrase value.

Return Type:
  • Changed response : 202 Accepted

DPSK passphrases updated

  • Changed content type : application/json

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

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

GET /dpskServices/{poolId}/passphrases
Parameters:
  • Changed: page in query

Page index starting from 0 (0..N)

Return Type:
  • Changed response : 200 OK

Passphrases

  • Changed content type : application/json

    • Changed property content (object)

      List of items contained in the current page.

    • Changed property empty (object)

      Whether the page is empty.

    • Changed property first (object)

      Whether this is the first page.

    • Changed property last (object)

      Whether this is the last page.

    • Changed property number (object)

      Current page index starting from 0.

    • Changed property numberOfElements (object)

      Number of items present in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for a page request, including page size, page number, and sorting metadata.

      • Changed property pageNumber (object)

        Requested page index starting from 0.

      • Changed property pageSize (object)

        Number of items to include in each page.

      • Changed property paged (object)

        Whether paging is enabled.

      • Changed property unpaged (object)

        Whether paging is disabled.

    • Changed property sort (object)

      Sorting details applied to the query.

      • Changed property empty (object)

        Whether no sorting is applied.

      • Changed property sorted (object)

        Whether sorting is applied.

      • Changed property unsorted (object)

        Whether sorting is not applied.

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

    • Changed property content (object)

      List of items contained in the current page.

    • Changed property empty (object)

      Whether the page is empty.

    • Changed property first (object)

      Whether this is the first page.

    • Changed property last (object)

      Whether this is the last page.

    • Changed property number (object)

      Current page index starting from 0.

    • Changed property numberOfElements (object)

      Number of items present in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for a page request, including page size, page number, and sorting metadata.

      • Changed property pageNumber (object)

        Requested page index starting from 0.

      • Changed property pageSize (object)

        Number of items to include in each page.

      • Changed property paged (object)

        Whether paging is enabled.

      • Changed property unpaged (object)

        Whether paging is disabled.

    • Changed property sort (object)

      Sorting details applied to the query.

      • Changed property empty (object)

        Whether no sorting is applied.

      • Changed property sorted (object)

        Whether sorting is applied.

      • Changed property unsorted (object)

        Whether sorting is not applied.

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

    • Changed property content (object)

      List of items contained in the current page.

    • Changed property empty (object)

      Whether the page is empty.

    • Changed property first (object)

      Whether this is the first page.

    • Changed property last (object)

      Whether this is the last page.

    • Changed property number (object)

      Current page index starting from 0.

    • Changed property numberOfElements (object)

      Number of items present in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for a page request, including page size, page number, and sorting metadata.

      • Changed property pageNumber (object)

        Requested page index starting from 0.

      • Changed property pageSize (object)

        Number of items to include in each page.

      • Changed property paged (object)

        Whether paging is enabled.

      • Changed property unpaged (object)

        Whether paging is disabled.

    • Changed property sort (object)

      Sorting details applied to the query.

      • Changed property empty (object)

        Whether no sorting is applied.

      • Changed property sorted (object)

        Whether sorting is applied.

      • Changed property unsorted (object)

        Whether sorting is not applied.

POST /dpskServices/{poolId}/passphrases/query
Request:
  • Changed content type : application/json

  • Added property maxDevicesPerPassphrase (object)

    Maximum number of devices to return per passphrase, preventing excessive data retrieval for passphrases with large device counts.

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property page (object)

    Page number, starting from index 0.

  • Changed property pageSize (object)

    Number of items per page.

  • Changed property searchString (object)

    Search string to match against the specified searchTargetFields.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort by.

  • Changed property sortOrder (object)

    Sort order: ASC for ascending, DESC for descending.

  • Changed property filters (object)

    Filter criteria for querying DPSK passphrases.

    • Changed property email (object)

      List of email addresses.

    • Changed property mac (object)

      List of MAC addresses.

    • Changed property networkId (object)

      List of network IDs.

    • Changed property passphrase (object)

      List of passphrases IDs.

    • Changed property phoneNumber (object)

      List of phone numbers.

    • Changed property status (object)

      Passphrase status filter: ACTIVE, REVOKED, or EXPIRED.

    • Changed property username (object)

      List of username criteria.

    • Changed property vlanId (object)

      List of VLAN IDs.

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

  • Added property maxDevicesPerPassphrase (object)

    Maximum number of devices to return per passphrase, preventing excessive data retrieval for passphrases with large device counts.

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property page (object)

    Page number, starting from index 0.

  • Changed property pageSize (object)

    Number of items per page.

  • Changed property searchString (object)

    Search string to match against the specified searchTargetFields.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort by.

  • Changed property sortOrder (object)

    Sort order: ASC for ascending, DESC for descending.

  • Changed property filters (object)

    Filter criteria for querying DPSK passphrases.

    • Changed property email (object)

      List of email addresses.

    • Changed property mac (object)

      List of MAC addresses.

    • Changed property networkId (object)

      List of network IDs.

    • Changed property passphrase (object)

      List of passphrases IDs.

    • Changed property phoneNumber (object)

      List of phone numbers.

    • Changed property status (object)

      Passphrase status filter: ACTIVE, REVOKED, or EXPIRED.

    • Changed property username (object)

      List of username criteria.

    • Changed property vlanId (object)

      List of VLAN IDs.

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

  • Added property maxDevicesPerPassphrase (object)

    Maximum number of devices to return per passphrase, preventing excessive data retrieval for passphrases with large device counts.

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property page (object)

    Page number, starting from index 0.

  • Changed property pageSize (object)

    Number of items per page.

  • Changed property searchString (object)

    Search string to match against the specified searchTargetFields.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort by.

  • Changed property sortOrder (object)

    Sort order: ASC for ascending, DESC for descending.

  • Changed property filters (object)

    Filter criteria for querying DPSK passphrases.

    • Changed property email (object)

      List of email addresses.

    • Changed property mac (object)

      List of MAC addresses.

    • Changed property networkId (object)

      List of network IDs.

    • Changed property passphrase (object)

      List of passphrases IDs.

    • Changed property phoneNumber (object)

      List of phone numbers.

    • Changed property status (object)

      Passphrase status filter: ACTIVE, REVOKED, or EXPIRED.

    • Changed property username (object)

      List of username criteria.

    • Changed property vlanId (object)

      List of VLAN IDs.

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

  • Added property maxDevicesPerPassphrase (object)

    Maximum number of devices to return per passphrase, preventing excessive data retrieval for passphrases with large device counts.

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property page (object)

    Page number, starting from index 0.

  • Changed property pageSize (object)

    Number of items per page.

  • Changed property searchString (object)

    Search string to match against the specified searchTargetFields.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort by.

  • Changed property sortOrder (object)

    Sort order: ASC for ascending, DESC for descending.

  • Changed property filters (object)

    Filter criteria for querying DPSK passphrases.

    • Changed property email (object)

      List of email addresses.

    • Changed property mac (object)

      List of MAC addresses.

    • Changed property networkId (object)

      List of network IDs.

    • Changed property passphrase (object)

      List of passphrases IDs.

    • Changed property phoneNumber (object)

      List of phone numbers.

    • Changed property status (object)

      Passphrase status filter: ACTIVE, REVOKED, or EXPIRED.

    • Changed property username (object)

      List of username criteria.

    • Changed property vlanId (object)

      List of VLAN IDs.

Return Type:
  • Changed response : 200 OK

Passphrases

  • Changed content type : application/json

    • Changed property fields (object)

      List of field names that were requested in the query.

    • Changed property page (object)

      Current page number starting from 0.

    • Changed property totalCount (object)

      Total number of items matching the query criteria across all pages.

    • Changed property totalPages (object)

      Total number of pages available based on the pageSize and totalCount.

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

    • Changed property fields (object)

      List of field names that were requested in the query.

    • Changed property page (object)

      Current page number starting from 0.

    • Changed property totalCount (object)

      Total number of items matching the query criteria across all pages.

    • Changed property totalPages (object)

      Total number of pages available based on the pageSize and totalCount.

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

    • Changed property fields (object)

      List of field names that were requested in the query.

    • Changed property page (object)

      Current page number starting from 0.

    • Changed property totalCount (object)

      Total number of items matching the query criteria across all pages.

    • Changed property totalPages (object)

      Total number of pages available based on the pageSize and totalCount.

POST /dpskServices/{poolId}/passphrases/query/csvFiles
Parameters:
  • Changed: date-format in query

Format will be applied for date values. Default value is "day/month/year hour:minute"

Request:
  • Changed content type : application/json

  • Added property maxDevicesPerPassphrase (object)

    Maximum number of devices to return per passphrase, preventing excessive data retrieval for passphrases with large device counts.

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property page (object)

    Page number, starting from index 0.

  • Changed property pageSize (object)

    Number of items per page.

  • Changed property searchString (object)

    Search string to match against the specified searchTargetFields.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort by.

  • Changed property sortOrder (object)

    Sort order: ASC for ascending, DESC for descending.

  • Changed property filters (object)

    Filter criteria for querying DPSK passphrases.

    • Changed property email (object)

      List of email addresses.

    • Changed property mac (object)

      List of MAC addresses.

    • Changed property networkId (object)

      List of network IDs.

    • Changed property passphrase (object)

      List of passphrases IDs.

    • Changed property phoneNumber (object)

      List of phone numbers.

    • Changed property status (object)

      Passphrase status filter: ACTIVE, REVOKED, or EXPIRED.

    • Changed property username (object)

      List of username criteria.

    • Changed property vlanId (object)

      List of VLAN IDs.

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

  • Added property maxDevicesPerPassphrase (object)

    Maximum number of devices to return per passphrase, preventing excessive data retrieval for passphrases with large device counts.

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property page (object)

    Page number, starting from index 0.

  • Changed property pageSize (object)

    Number of items per page.

  • Changed property searchString (object)

    Search string to match against the specified searchTargetFields.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort by.

  • Changed property sortOrder (object)

    Sort order: ASC for ascending, DESC for descending.

  • Changed property filters (object)

    Filter criteria for querying DPSK passphrases.

    • Changed property email (object)

      List of email addresses.

    • Changed property mac (object)

      List of MAC addresses.

    • Changed property networkId (object)

      List of network IDs.

    • Changed property passphrase (object)

      List of passphrases IDs.

    • Changed property phoneNumber (object)

      List of phone numbers.

    • Changed property status (object)

      Passphrase status filter: ACTIVE, REVOKED, or EXPIRED.

    • Changed property username (object)

      List of username criteria.

    • Changed property vlanId (object)

      List of VLAN IDs.

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

  • Added property maxDevicesPerPassphrase (object)

    Maximum number of devices to return per passphrase, preventing excessive data retrieval for passphrases with large device counts.

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property page (object)

    Page number, starting from index 0.

  • Changed property pageSize (object)

    Number of items per page.

  • Changed property searchString (object)

    Search string to match against the specified searchTargetFields.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort by.

  • Changed property sortOrder (object)

    Sort order: ASC for ascending, DESC for descending.

  • Changed property filters (object)

    Filter criteria for querying DPSK passphrases.

    • Changed property email (object)

      List of email addresses.

    • Changed property mac (object)

      List of MAC addresses.

    • Changed property networkId (object)

      List of network IDs.

    • Changed property passphrase (object)

      List of passphrases IDs.

    • Changed property phoneNumber (object)

      List of phone numbers.

    • Changed property status (object)

      Passphrase status filter: ACTIVE, REVOKED, or EXPIRED.

    • Changed property username (object)

      List of username criteria.

    • Changed property vlanId (object)

      List of VLAN IDs.

Return Type:
  • Changed response : 200 OK

Exported passphrases

  • Changed content type : text/csv
  • Changed response : 400 Bad Request

Invalid timezone or date format supplied

  • New content type : application/json

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

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

  • New content type : text/csv

  • New content type : text/vnd.ruckus.v1+csv

POST /templates/dpskServices/query

Search DPSK Pool Templates

Request:

New content type : application/json

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

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property page (object)

    Page number, starting from index 0.

  • Changed property pageSize (object)

    Number of items per page.

  • Changed property searchString (object)

    Search string to match against the specified searchTargetFields.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort by.

  • Changed property sortOrder (object)

    Sort order: ASC for ascending, DESC for descending.

  • Changed property filters (object)

    Filter criteria for querying DPSK pools.

    • Changed property isEnforced (object)

      Whether enforcement is enabled for this instance.

    • Changed property passphraseFormat (object)

      An enum indicating the character set included in the passphrase. Supported values: NUMBERS_ONLY, KEYBOARD_FRIENDLY, MOST_SECURED.

Return Type:
  • Changed response : 200 OK

DPSK pool templates

  • New content type : application/json

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

    • Changed property fields (object)

      List of field names that were requested in the query.

    • Changed property page (object)

      Current page number starting from 0.

    • Changed property totalCount (object)

      Total number of items matching the query criteria across all pages.

    • Changed property totalPages (object)

      Total number of pages available based on the pageSize and totalCount.

Previous page
Next page