Skip to content

DPSK API & Model Documentation (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 Template Management

Operations

APIs for DPSK Service Management

Operations

APIs for DPSK Passphrase Management

Operations

APIs for DPSK Passphrase Device Management

Operations

Get Passphrase Devices

Request

Path
passphraseIdstringrequired

DPSK passphrase id

poolIdstringrequired

DPSK pool id

No request payload

Responses

Get Passphrase Devices

Body
macstring
lastConnectedNetworkstring
lastConnectedNetworkIdstring
lastConnectedTimestring(date-time)
deviceConnectivitystring
devicePassphrasestring
lastConnectedstring(date-time)
onlinebooleanDeprecated
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

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
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Delete Devices Associated with Passphrase

Request

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
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
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
searchTargetFieldsArray of strings
searchStringstring
{
  "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)
totalPagesinteger(int32)
sizeinteger(int32)
contentArray of objects
numberinteger(int32)
sortobject(SortObject)
pageableobject(PageableObject)
numberOfElementsinteger(int32)
firstboolean
lastboolean
emptyboolean
Response
{
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "content": [
    {}
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "unsorted": true,
    "sorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": { … },
    "unpaged": true,
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "empty": true
}