Skip to content
/APIs for DPSK Service

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 Specific DPSK Pool

Request

Get specific DPSK pool by ID.

Path
poolIdstringrequired

DPSK pool id

No request payload

Responses

DPSK pool

Body
idstring[ 0 .. 255 ] charactersread-only

Unique identifier for pool.

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.

createdDatestring(date-time)read-only

Creation date timestamp record.

lastModifiedDatestring(date-time)read-only

Last modification timestamp record.

isReferencedbooleanread-only

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

networkCountinteger(int32)read-only

Number of networks associated with this pool.

isEnforcedbooleanread-only

Whether enforcement is enabled for this template.

identityGroupIdstring

Linked identity group ID. Only editable for template.

identityIdstringDeprecatedread-only

Deprecated. Use identity group ID instead.

Response
{
  "id": "string",
  "name": "string",
  "passphraseFormat": "MOST_SECURED",
  "passphraseLength": 0,
  "policyDefaultAccess": true,
  "deviceCountLimit": 0,
  "expirationType": "SPECIFIED_DATE",
  "expirationOffset": 0,
  "expirationDate": "2019-08-24T14:15:22Z",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "isReferenced": true,
  "networkCount": 0,
  "isEnforced": true,
  "identityId": "string",
  "identityGroupId": "string"
}

Update the DPSK Pool

Request

Update the specified DPSK pool with the provided details.

Path
poolIdstringrequired

DPSK pool id

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

The update request has been accepted and is in progress.

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 the DPSK Pool

Request

Delete the specified DPSK pool.

Path
poolIdstringrequired
No request payload

Responses

The delete request has been accepted and is in progress.

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

Update the DPSK Pool

Request

Partially update the specified DPSK pool.

Path
poolIdstringrequired

DPSK pool id

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

The update request has been accepted and is in progress.

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

Update DPSK Pool Policy Set

Request

Update the policy set associated with the DPSK pool.

Path
poolIdstringrequired

DPSK passphrase id

policySetIdstringrequired

Policy set id

No request payload

Responses

The update request has been accepted and is in progress

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

Remove DPSK Pool Policy Set

Request

Remove the policy set associated with the specified DPSK pool.

Path
poolIdstringrequired

DPSK passphrase id

policySetIdstringrequired

Policy set id

No request payload

Responses

The update request has been accepted and is in progress

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

Create New DPSK Pool

Request

Create a new DPSK pool under the specified identity group.

Path
identityGroupIdstringrequired

Identity group id

Bodyapplication/jsonrequired
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.

application/json
{
  "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"
}

Search for DPSK Pools

Request

Search for DPSK pools matching search string in paged result.

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.

filtersobject(DpskPoolFilters)

Filter criteria used to query DPSK pools.

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "passphraseFormat": [ … ],
    "isEnforced": true
  }
}

Responses

DPSK pools

Body
fieldsArray of strings

List of field names that were requested in the query.

totalCountinteger(int64)

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

totalPagesinteger(int32)

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

pageinteger(int32)

Current page number starting from 0.

dataArray of objects(DpskPoolDto)

DPSK services in page.

Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "totalPages": 0,
  "page": 0,
  "data": [
    { … }
  ]
}

Get DPSK Pools by Network

Request

Get DPSK pools associated with the specified Wi-Fi network.

Path
networkIdstringrequired

Wifi network id

Query
pageableobject(Pageable)required

parameters for paging

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

Responses

DPSK pool

Body
fieldsArray of strings

List of field names that were requested in the query.

totalCountinteger(int64)

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

totalPagesinteger(int32)

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

pageinteger(int32)

Current page number starting from 0.

dataArray of objects(DpskPoolDto)

DPSK services in page.

Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "totalPages": 0,
  "page": 0,
  "data": [
    { … }
  ]
}

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

APIs for DPSK Service Template

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

Operations