DPSK Pools

You can use REST API v2 calls to obtain information about existing DPSK pools, to create or edit pools, and to delete pools.
Note: This resource does not currently support sorting, paging, or filtering.

The following table lists the properties that can be used in the body of a DPSK-pool-related request and/or are provided in the response body. (In the "Optional" column, if a default value is applicable, it is listed in angle brackets (< >).

Resource: DPSK Pools

Property Name Type Editable Optional in Request/Response Body? Description
guid String No Optional on create only, but not on any subsequent uses The unique identifier for this DPSK pool.
additionalAttributes List <Attribute> Yes Yes A list of additional attributes to apply to RADIUS configurations. In the Configuration > DPSK Pools portion of the UI, if you add or modify a DPSK pool, you can click + at the bottom of the Policies section to invoke a drop-down of all the additional attributes that are available. Also, see the "Resource: Additional Attributes" table below for more information.
Note: In the UI, you can click the Variables arrow to view a list of supported variables.
how would they know which variables can be used for which properties or additional attributes?
classid String Yes Yes The device class ID to use. If not specified, the device is not assigned a class ID.
description String Yes No A description for this pool.
deviceCountLimit Int Yes No <1> If you set the enforceDeviceCountLimit parameter to true, you can specify the number of devices that are allowed to utilize the DPSK pool you are creating.
displayName String Yes No The display name for this pool; must be unique.
enabled Boolean Yes No<true> Indicates if this DPSK pool is enabled. Switching from true to false disables the pool.
enforceDeviceCountLimit Boolean Yes No<false> If true, each DPSK is assigned a maximum device count as specified in the deviceCountLimit parameter. If false, an unlimited number of devices can utilize the DPSK.
enforceExpirationDate Boolean Yes No <false> If true, newly generated DPSKs are assigned an expiration date that is based on the creation date and the defined offset.
expirationDateType String Yes No <END_OF_MONTH> A Specific date in format YYYYMMDD, or a type of: MINUTES_AFTER_TIME, HOURS_AFTER_TIME, DAYS_AFTER_TIME, WEEKS_AFTER_TIME, MONTHS_AFTER_TIME, QUARTERS_AFTER_TIME , YEARS_AFTER_TIME , END_OF_HOUR , END_OF_DAY , END_OF_WEEK , END_OF_MONTH , END_OF_QUARTER , END_OF_HALF , END_OF_YEAR
expirationDateValue Int Yes No <1> Will be used if HOURS_AFTER_TIME is provided in the expirationDataType
filterid String Yes Yes Filter ID for the device in the pool. If not specified, the device is not assigned a filter ID.
phraseDefaultLength int Yes No<12> The pass phrase default length.
phraseRandomCharactersType Enum <String> Yes No An enum that indicates the characters to be included in the passphrase. ALPHANUMERIC_UPPER, ALPHANUMERIC_LOWER, ALPHANUMERIC_MIXED, ALPHABETIC_UPPER, ALPHABETIC_LOWER, ALPHABETIC_MIXED, NUMERIC, ASCII
sessionTimeout Long Yes No The reauthentication period, in seconds, included in the RADIUS reply for successful authentications. If the device stays connected for longer than this period, the WLAN or switch requires that the device be reauthenticated (invisibly to the user). If not specified, sessionTimeout is not applied, which means that the device is not required to reauthenticate as long as it remains associated.
ssidList List <String> Yes No A list of SSIDs as strings for this DPSK pool.
vlanid String Yes Yes The VLAN to use. If not specified, the device receives the default VLAN that is configured on the controller. This property value can be one of the DPSK-supported environmental variables.

Resource: Additional Attributes:

The following table lists the additional-attribute properties to apply to RADIUS configurations that can be used in the body of a DPSK-pool-related request and/or are provided in the response body.

Note: In the Configuration > DPSK Pools portion of the UI, if you add or modify a DPSK pool, you can click + at the bottom of the Policies section to invoke a drop-down of all the additional attributes that are available.

Resource: Additional Attributes

Property Name Type Editable Filter or Sort Optional? Description
name String Yes No No The RADIUS attribute to use.
action String <Enum> Yes No No The action to take must be one of the following: ADD, ADD_OR_REPLACE, or ADD_MULTIPLE.
value String Yes No No The value to substitute.

DPSK Pool URIs and Actions

The following table indicates the URIs that you can append to the root URI, along with the actions you can take, and possible return codes you can receive.

DPSK Pool URIs and Actions

URI Action Description Return Codes
/dpskPools GET Returns the list of all DPSK pools that are in the system.

401 - Unauthorized

200 - OK

POST Creates a DPSK pool.

401 - Unauthorized

201 - Created

/dpskPools/{guid} GET Returns the specific DPSK pool.

404 - Not Found

401 - Unauthorized

200 - OK

DELETE Deletes the pool specified and all its child resources, including DPSKs, devices, and associated enrollments.

500 - Internal Server Error (such as " Pool in use")

401 - Unauthorized

204 - No content

200 - OK

PUT Updates aa DPSK pool. See the "Resource: DPSK Pools" and "Additional Attributes" tables above for what properties can be edited.

404 - Not Found

401 - Unauthorized

200 - OK

Example of Using GET for DPSK Pools

This example demonstrates how to obtain information about a DPSK pool that has already been created in the Cloudpath UI. (Instructions on creating DPSK pools in the UI are located in the Cloudpath Enrollment System Ruckus External Dynamic Pre-Shared Key (eDPSK) Configuration Guide.) The following figure shows information about a DPSK pool called DPSK Pool 1 that has been created in the UI.

DPSK Pool 1 Created in the UI

URI:

This example uses the following URI:

 https://Jeff243.cloudpath.net/admin/apiv2/BmGsez6evQc8/dpskPools

where:

  • https://Jeff243.cloudpath.net/admin/apiv2 is the root URI of the Cloudpath system being used (must include https, as shown)
  • BmGsez6evQc8 is an example of an API key generated from the Configuration > API Keys section of the Cloudpath UI

Request Headers:

The following table shows the required request headers for this URI example, with an example value of an active token that must be pasted into the Authorization header value:

Request Headers

Key Value
Content-type application/json
Authorization eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqZWZmLnJob2RpZUBjb21tc2NvcGUuY29tIiwicm9sZVBrIjoiMjEwMDAiLCJhY2NvdW50QWRtaW5QayI6IjIiLCJhcGlLZXkiOiJaV2NjTGpQZUdZMGUiLCJpYXQiOjE1NzU1NzUxNTcsImV4cCI6MTU3NTU3NTQ1N30.2q4KTyDUevkAAz7mJyp529Be1-ip3EC8P06Xarmz5ao

Request Body:

None required.

Action:

Use the GET action to send the request.

Response Body:

Once the request is sent, you will receive a "Status: 200 OK" if the GET is successful. The response body provides information about all existing DPSK pools in your Cloudpath system. In this example, DPSK Pool 1 is the only existing pool. You can see that the information in the response body matches the configuration of DPSK Pool 1 as specified in the UI (for example, the "guid" values are the same in each place, the SSID list is the same, and so on). Any values that were not specified in the UI are the default values:

{
    "page": {
        "page": 1,
        "pageSize": 1,
        "totalCount": 1
    },
    "contents": [
        {
            "guid": "AccountDpskPool-8932A3B4-BDAB-4636-AC37-08E663D84CB3",
            "displayName": "DPSK Pool 1",
            "description": "",
            "enabled": true,
            "phraseDefaultLength": 12,
            "phraseRandomCharactersType": "ALPHABETIC_LOWER",
            "ssidList": [
                "SSID1",
                "SSID2"
            ],
            "enforceExpirationDate": false,
            "expirationDateType": "MONTHS_AFTER_TIME",
            "expirationDateValue": "1",
            "enforceDeviceCountLimit": false,
            "deviceCountLimit": 1,
            "vlanid": "",
            "filterid": "",
            "classid": "",
            "additionalAttributes": []
        }
    ]
}

Example of Using POST to Create a DPSK Pool

This example demonstrates how to create a new DPSK pool in your Cloudpath system by using the REST API POST call.

URI:

This example uses the following URI:

 https://Jeff243.cloudpath.net/admin/apiv2/BmGsez6evQc8/dpskPools

where:

  • https://Jeff243.cloudpath.net/admin/apiv2 is the root URI of the Cloudpath system being used (must include https, as shown)
  • BmGsez6evQc8 is an example of an API key generated from the Configuration > API Keys section of the Cloudpath UI

Request Headers:

The following table shows the required request headers for this URI example, with an example value of an active token that must be pasted into the Authorization header value:

Request Headers

Key Value
Content-type application/json
Authorization eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqZWZmLnJob2RpZUBjb21tc2NvcGUuY29tIiwicm9sZVBrIjoiMjEwMDAiLCJhY2NvdW50QWRtaW5QayI6IjIiLCJhcGlLZXkiOiJaV2NjTGpQZUdZMGUiLCJpYXQiOjE1NzU1NzUxNTcsImV4cCI6MTU3NTU3NTQ1N30.2q4KTyDUevkAAz7mJyp529Be1-ip3EC8P06Xarmz5ao

Request Body:

The following is an example of a request body for creating a DPSK pool. You can refer to the preceding Resource tables for a list and descriptions of properties you can use to define your pool. For instance, in this example, a pool called "DPSK Pool 20" is being created with the values provided in the body.

{
    "displayName": "DPSK Pool 20",
    "description": "",
    "enabled": true,
    "phraseDefaultLength": 11,
    "phraseRandomCharactersType": "ALPHABETIC_LOWER",
    "ssidList": [
        "SSID19",
        "SSID20"
    ],
    "enforceExpirationDate": false,
    "expirationDateType": "MONTHS_AFTER_TIME",
    "expirationDateValue": "1",
    "enforceDeviceCountLimit": true,
    "deviceCountLimit": 4,
    "vlanid": "777",
    "filterid": "",
    "classid": "",
    "additionalAttributes": [
        {
            "name": "User-Name",
            "action": "ADD_OR_REPLACE",
            "value": "${DPSK.THRIDPARTY_ID}"
        },
        {
            "name": "Callback-Number",
            "action": "ADD",
            "value": "1234"
        }
    ]
}

Action:

Use the POST action to send the request.

Response Body:

Once the request is sent, you will receive a "Status: 201 Created" if the POST is successful. You can see that a "guid" (a unique identifier for the newly created pool) is included in the response body.

{
    "guid": "AccountDpskPool-37AF7D9B-7A3A-4953-B314-10A4758803DE",
    "displayName": "DPSK Pool 20",
    "description": "",
    "enabled": true,
    "phraseDefaultLength": 11,
    "phraseRandomCharactersType": "ALPHABETIC_LOWER",
    "ssidList": [
        "SSID19",
        "SSID20"
    ],
    "enforceExpirationDate": false,
    "expirationDateType": "MONTHS_AFTER_TIME",
    "expirationDateValue": "1",
    "enforceDeviceCountLimit": true,
    "deviceCountLimit": 4,
    "vlanid": "777",
    "filterid": "",
    "classid": "",
    "additionalAttributes": [
        {
            "name": "User-Name",
            "action": "ADD_OR_REPLACE",
            "value": "${DPSK_THIRDPARTY_ID}"
        },
        {
            "name": "Callback-Number",
            "action": "ADD",
            "value": "1234"
        }
    ]
}

Verifying the Newly Created DPSK Pool in the Cloudpath UI:

You can go to the Configuration > DPSK Pools area of the UI, and expand the pool to confirm that the pool was created correctly. The values should match those in the Response body from the POST. For example, in this expanded view, you can see that the GUID matches the one provided in the Response body.

Expanded View in UI of Pool Created With an API Post Call

If you go to the Edit view of the pool, you see additional pool values. Again, they should match the values you assigned to the properties you used in your POST.

Edit View of Pool Created With an API Post Call