DPSK Pools

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.

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 Body:

None required.

Action:

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-8c95a636-59ff-4a85-a1ce-e2b6984f5a50",
            "displayName": "DPSK Pool 1",
            "description": "",
            "enabled": true,
            "phraseDefaultLength": 12,
            "phraseRandomCharactersType": "ALPHABETIC_LOWER",
            "ssidList": [
                "ssid 22"
            ],
            "enforceExpirationDate": false,
            "expirationDateType": "MONTHS_AFTER_TIME",
            "expirationDateValue": "1",
            "enforceDeviceCountLimit": false,
            "deviceCountLimit": 1,
            "supportsPolicies": true,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/BmGsez6evQc8/dpskPools/AccountDpskPool-8c95a636-59ff-4a85-a1ce-e2b6984f5a50",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "dpsks",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/BmGsez6evQc8/dpskPools/AccountDpskPool-8c95a636-59ff-4a85-a1ce-e2b6984f5a50/dpsks?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "policy",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/BmGsez6evQc8/dpskPools/AccountDpskPool-8c95a636-59ff-4a85-a1ce-e2b6984f5a50/policies?page=1&pageSize=100{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

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

Action:

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-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
    "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,
    "supportsPolicies": true,
    "links": [
        {
            "rel": "self",
            "href": "https://jeff243.cloudpath.net/admin/apiv2/BmGsez6evQc8/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        },
        {
            "rel": "dpsks",
            "href": "https://jeff243.cloudpath.net/admin/apiv2/BmGsez6evQc8/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks?page=1&pageSize=10{&filter,orderBy}",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        },
        {
            "rel": "policy",
            "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/policies?page=1&pageSize=100{&filter,orderBy}",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        }
    ]
}

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