Skip to content
DPSK Service/
/
Get DPSK Pools

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

Get DPSK PoolsDeprecated

Request

This method will be removed no sooner than 08/31/2026. The following URL /dpskServices/query can be used for this content.

Query
namestring

Filter by dpsk service name

networkIdstring

Filter by associated wifi network

lockedboolean

Filter by association status. true if locked by other service

pageableobject(Pageable)required

parameters for paging

pageable.​pageinteger(int32)>= 0
pageable.​sizeinteger(int32)>= 1
pageable.​sortArray of strings
No request payload

Responses

DPSK pools

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
}

Create New DPSK PoolDeprecated

Request

This method will be removed no sooner than 08/31/2026.

Body
required
namestring[ 2 .. 32 ] charactersrequired
passphraseFormatstringrequired

Format type of the passphrase.

Enum"MOST_SECURED""KEYBOARD_FRIENDLY""NUMBERS_ONLY"
passphraseLengthinteger(int32)required

Minimum allowed length for the passphrase.

policyDefaultAccessboolean

Default access if no policy rule matches.

deviceCountLimitinteger(int32)

Maximum number of devices allowed per passphrase.

expirationTypestring

Expiration date rule of pool.

Enum"SPECIFIED_DATE""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""YEARS_AFTER_TIME"
expirationOffsetinteger(int32)

Date of expiration offset.

expirationDatestring(date-time)

Expiration date of pool.

identityGroupIdstring

Linked identity group ID. Only editable for template.

{
  "name": "string",
  "passphraseFormat": "MOST_SECURED",
  "passphraseLength": 0,
  "policyDefaultAccess": true,
  "deviceCountLimit": 0,
  "expirationType": "SPECIFIED_DATE",
  "expirationOffset": 0,
  "expirationDate": "2019-08-24T14:15:22Z",
  "identityGroupId": "string"
}

Responses

DPSK pool created

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"
}