Skip to content
DPSK Service/
/
List Passphrase Devices

DPSK Service (0.0.3)

Overview

The DPSK REST APIs provide endpoints to manage DPSK resources, including pools, passphrases devices, and templates.

What This API Does

  • Create, modify, and delete DPSK pools
  • Create, modify, and delete passphrases within pools
  • Manage devices associated with passphrases
  • Manage DPSK service templates and REC templates
  • Associate policy sets with DPSK pools
  • Import and export passphrase data via CSV
  • Search passphrases by client network and MAC address

Error Handling

The API uses standard HTTP status codes with detailed error messages in the response body.

Common Error Responses

All endpoints may return these common error responses:

  • 400 Bad Request: Invalid input data or validation errors
  • 401 Unauthorized: Missing or invalid authentication
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Requested resource doesn't exist
  • 409 Conflict: Resource conflict (e.g., duplicate names)
  • 422 Unprocessable Entity: Business rule violations
  • 500 Internal Server Error: Unexpected server errors
Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud

APIs for DPSK Service

Operations for managing DPSK pools, including create, update, delete, and policy management.

Operations

APIs for DPSK Passphrase

Operations for managing DPSK passphrases, CSV import/export, and query support.

Operations

APIs for DPSK Passphrase Device

Operations for managing devices linked to DPSK passphrases.

Operations

Get Passphrase Devices

Request

Get all devices associated with the specified DPSK passphrase.

Path
passphraseIdstringrequired

DPSK passphrase id

poolIdstringrequired

DPSK pool id

No request payload

Responses

Get passphrase devices

Body
macstring

Device MAC address record.

lastConnectedNetworkstring

SSID of the last network the device connected to.

lastConnectedNetworkIdstring

ID of the last network the device connected to.

lastConnectedTimestring(date-time)

Timestamp of the last connection in ISO format.

deviceConnectivitystring

Device connectivity status indicator.

devicePassphrasestring

Passphrase used by the device.

lastConnectedstring(date-time)

Formatted timestamp of the last connection for display.

onlinebooleanDeprecated

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

Response
{
  "mac": "string",
  "lastConnectedNetwork": "string",
  "lastConnectedNetworkId": "string",
  "lastConnectedTime": "2019-08-24T14:15:22Z",
  "deviceConnectivity": "string",
  "devicePassphrase": "string",
  "lastConnected": "2019-08-24T14:15:22Z",
  "online": true
}

Create Devices for Passphrase

Request

Create devices for a specific passphrase.

Path
passphraseIdstringrequired

DPSK passphrase ID

poolIdstringrequired

DPSK pool ID

Body
requiredArray [
string
]
[
  "00:11:22:33:44:55",
  "00:11:22:33:44:56"
]

Responses

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

Body
requestIdstring

Identifier for tracking the asynchronous request.

idstring

Optional resource ID affected or created by the operation.

Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Delete Devices Associated with Passphrase

Request

Delete devices associated with a specific passphrase.

Path
passphraseIdstringrequired

DPSK passphrase ID

poolIdstringrequired

DPSK pool ID

Body
requiredArray [
string
]
[
  "00:11:22:33:44:55",
  "00:11:22:33:44:56"
]

Responses

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

Body
requestIdstring

Identifier for tracking the asynchronous request.

idstring

Optional resource ID affected or created by the operation.

Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

List Passphrase Devices

Request

List paginated devices for the specified DPSK passphrase.

Path
passphraseIdstringrequired

DPSK passphrase id

poolIdstringrequired

DPSK pool id

Body
required
fieldsArray of strings

List of field names to include in the response.

pageinteger(int32)

Page number, starting from index 0.

pageSizeinteger(int32)

Number of items per page.

sortFieldstring

Field name to sort by.

sortOrderstring

Sort order: ASC for ascending, DESC for descending.

Enum"ASC""DESC"
searchTargetFieldsArray of strings

List of field names to search within.

searchStringstring

Search string to match against the specified searchTargetFields.

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string"
}

Responses

The request to list devices for the specified passphrase has succeeded.

Body
totalElementsinteger(int64)

Total number of items across all pages.

totalPagesinteger(int32)

Total number of pages available.

sizeinteger(int32)
contentArray of objects

List of items contained in the current page.

numberinteger(int32)

Current page index starting from 0.

sortobject(SortObject)

Sorting details applied to the query.

numberOfElementsinteger(int32)

Number of items present in the current page.

pageableobject(PageableObject)

Pagination information associated with this page.

firstboolean

Whether this is the first page.

lastboolean

Whether this is the last page.

emptyboolean

Whether the page is empty.

Response
{
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "content": [
    null
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "unsorted": true,
    "sorted": true
  },
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "sort": { … },
    "unpaged": true,
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0
  },
  "first": true,
  "last": true,
  "empty": true
}

APIs for DPSK Service Template

Operations for managing DPSK templates, including creation, cloning, and network template association.

Operations