DPSKs

You can use REST API v2 calls to obtain information about existing DPSKs, to create or edit DPSKs, and to delete DPSKs.
entire section updated for 5.7R2

The following table lists the properties that can be used in the body of a DPSK-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: DPSKs

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
guid String No Neither Optional on create only, but not on any subsequent uses The unique identifier for this PSK.
name String Yes sortBy, like No The reference name of the item.
thirdPartyId String Yes sortBy , like No A string that can be used by third-party consumers. This can be referenced using attribute variables in RADIUS attributes as: DPSK.THIRDPARTY_ID
passphrase String Yes Neither Optional on create only, but not on any subsequent uses The pre-shared key for this PSK, which will be automatically assigned if not provided in a POST. This string will always be returned with the resource.
Note:
added this for 5.7R2
This property cannot be edited when devices are associated with the DPSK (deviceCount > 0). If this field is edited while deviceCount > 0, then a "409 Conflict" message will be returned.
status Enum <String> Yes in, eq No The status of the PSK. Options are: ACTIVE, EXPIRED, or REVOKED. A change to REVOKED or ACTIVE can be requested but only for a DPSK whose state is not EXPIRED.
ssidList List <String> Yes Neither No If not null, this is the list of SSIDs on which the DPSK can be used. This value must be a subset of the SSIDs assigned to the corresponding DPSK pool. If the ssidList property is not specified, the DPSK can be used on any SSID contained in the "ssids" field of the corresponding DPSK pool.
Note: This field cannot be edited when devices are associated with the DPSK (deviceCount > 0). If this field is edited while deviceCount > 0, then a "409 Conflict" message will be returned.
added for 5.7r2
expirationDateTime String < DateTime> Yes sortBy Yes The DPSK (and the devices registered to the DPSK) will no longer be usable after the date and time specified. ISO 8601 formatted date is used for this property.
useExpirationDate boolean Yes Neither No <true> Indicates if expiration date time should be used.
useDeviceCountLimit boolean Yes Neither No <false> Indicates that the system will enforce the device count limit for this specific DPSK.
deviceCountLimit Long Yes Neither Yes If specified, this DPSK will have its own device count limit enforced independently of the corresponding DPSK pool.
deviceCount Integer No Neither Yes The number of devices currently associated with the DPSK. This is provided for information only and cannot be changed. If a different number is given in a POST or PUT, the number is ignored.
revokedDateTime String < DateTime> No Neither Yes The date time (in ISO 8601 date time format) that the DPSK was revoked.
revocationReason String Yes Neither Yes If the status is changed to REVOKED, this is the "reason for the revocation."
vlanId String Yes Neither No If specified, this VLAN ID will override the VLAN ID specified within the corresponding DPSK pool.
overrideReauthentication String Yes Neither Yes If specified, this Reauthentication value will override the value specified within the DPSK pool.
link Link No No No The following links are included as hrefs for use in other API calls:
  • self-referencing link
  • link to parent eDPSK pool
  • link to devices associated with the DPSk

DPSK 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 URIs and Actions

URI Action Description Return Codes
dpskPools /{poolGuid}/dpsks GET Returns the list of PSKs that are part of the identified pool.

200 - OK

404 -Not Found

POST Creates a PSK in the identified pool.

201- Created

404 - Not Found

/dpskPools/{poolGuid}/dpsks/{guid} GET Returns the specified PSK.

200 - OK

404 - Not Found

DELETE Deletes the specified PSK.

200 - OK

204 - No content

401-Unauthorized
PUT Updates a PSK. SeeResource: DPSKs for which properties can be edited.

200 - OK

401-Unauthorized

404 -Not Found

409 - Conflict

Example of Using PUT to Edit a DPSK Within an Existing DPSK Pool

This example demonstrates how to edit a DPSK that has already been created either by using the UI or by using a REST API POST call. In Example of Using POST to Create a DPSK Pool, an example shows the creation of a pool called DPSK Pool 20. Suppose that a DPSK called DPSK15 was then created within that pool. The following figure shows the properties of DPSK15 from the UI:

DPSK15 Information in UI Before API PUT Call

URI:

This example uses the following URI: 

 https://Jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8
/dpsks/AccountDpsk-4b67741c-5b87-48dc-b3c8-306f28ee7a38

where:

  • https://Jeff243.cloudpath.net/admin/apiv2 is the root URI of the Cloudpath system being used (must include https, as shown)
  • 5XcTc6SjkHDL is an example of an API key generated from the Configuration > API Keys section of the Cloudpath UI
  • AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8 is the GUID of the DPSK pool to which this DPSK belongs
  • AccountDpsk-4b67741c-5b87-48dc-b3c8-306f28ee7a38 is the GUID of this specific DPSK that will be edited (see the figure above for this GUID)

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 editing the DPSK called DPSK.

Note: To create the body of a PUT request, you can start by first doing a GET request on the DPSK that you want to edit. After a successful GET request, copy and paste the entire response body into the request body of your GET. Then, edit the values you want to change. In the example shown below, the ssidList has been changed to null, and the vlanID has been changed to 44.
. 
{
    "guid": "AccountDpsk-4b67741c-5b87-48dc-b3c8-306f28ee7a38",
    "name": "DPSK15",
    "passphrase": "cemqwzmzgit",
    "status": "ACTIVE",
    "ssidList": [],
    "expirationDateTime": "2020-12-06T00:00-07:00[America/Denver]",
    "useDeviceCountLimit": false,
    "deviceCountLimit": 0,
    "vlanid": "44"
}

Action:

Use the PUT action to send the request.

Response Body:

Once the request is sent, you will receive a "Status: 200 OK" if the PUT is successful. You can see that the response body below matches what was requested in the request body above. The response body also includes the href links that are listed in Resource: DPSKs.

{
    "guid": "AccountDpsk-4b67741c-5b87-48dc-b3c8-306f28ee7a38",
    "name": "DPSK15",
    "passphrase": "cemqwzmzgit",
    "status": "ACTIVE",
    "ssidList": [],
    "expirationDateTime": "2020-12-06T07:00:00Z",
    "useDeviceCountLimit": false,
    "deviceCountLimit": 0,
    "deviceCount": 0,
    "vlanid": "44",
    "links": [
        {
            "rel": "self",
            "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-4b67741c-5b87-48dc-b3c8-306f28ee7a38",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        },
        {
            "rel": "parent",
            "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        },
        {
            "rel": "devices",
            "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-4b67741c-5b87-48dc-b3c8-306f28ee7a38/devices?page=1&pageSize=10{&filter,orderBy}",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        }
    ]
}

Verifying the Edited DPSK in the Cloudpath UI:

You can go to the Configuration > DPSK Pools area of the UI, and click the view icon of the desired DPSK in the "DPSKs" section of the window to confirm that the DPSK was edited correctly. The values should match those in the Response body from the PUT. For example, you can see that the SSID list no longer has any restrictions, and that the VLAN ID has been changed to 44.

DPSK15 Information in UI After API PUT Call

Example of Using GET to Obtain Listings of Multiple DPSKs Within an Existing DPSK Pool

This example demonstrates how to use a GET call to obtain a full list of DPSKs. In this example, six DPSKs have been created in the pool called DPSK Pool 20, as shown in the following figure:

Listing of Multiple DPSKs Within a Pool

URI:

This example uses the following URI: 

 https://Jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks

where:

  • https://Jeff243.cloudpath.net/admin/apiv2 is the root URI of the Cloudpath system being used (must include https, as shown)
  • 5XcTc6SjkHDL is an example of an API key generated from the Configuration > API Keys section of the Cloudpath UI
  • AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8 is the GUID of the DPSK pool from which you want a listing of all its DPSKs and their respective properties.

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:

No request body is needed for this request. All the necessary information is in the URI.

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 below lists information for each of the six DPSKs within the corresponding pool. The first part of the output shows the page information: All the information is on page 1, the page size is currently 6 (meaning there are six items on page 1), and the total number of DPSKs listed is 6. 

{
    "page": {
        "page": 1,
        "pageSize": 6,
        "totalCount": 6
    },
    "contents": [
        {
            "guid": "AccountDpsk-e45f6b14-2cff-4c8d-b44e-102fd67fe02c",
            "name": "DPSK23",
            "passphrase": "xzhjmjzdaoo",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e45f6b14-2cff-4c8d-b44e-102fd67fe02c",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e45f6b14-2cff-4c8d-b44e-102fd67fe02c/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-bc993a37-05f4-4a39-8fe3-6a888b35f2c1",
            "name": "DPSK30",
            "passphrase": "uoosztyuoel",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-bc993a37-05f4-4a39-8fe3-6a888b35f2c1",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-bc993a37-05f4-4a39-8fe3-6a888b35f2c1/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-5ed29464-d571-48be-a0d0-7574ab87b93d",
            "name": "DPSK31",
            "passphrase": "jekgqviayiv",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-5ed29464-d571-48be-a0d0-7574ab87b93d",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-5ed29464-d571-48be-a0d0-7574ab87b93d/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-e7e2fe17-912d-4826-8010-05f3263f8fe8",
            "name": "DPSK32",
            "passphrase": "wilfyhhumqc",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e7e2fe17-912d-4826-8010-05f3263f8fe8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e7e2fe17-912d-4826-8010-05f3263f8fe8/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-fce6d0e6-19a1-464c-850c-31bde9472c52",
            "name": "DPSK33",
            "passphrase": "zygrjkezfry",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-fce6d0e6-19a1-464c-850c-31bde9472c52",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-fce6d0e6-19a1-464c-850c-31bde9472c52/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-4b67741c-5b87-48dc-b3c8-306f28ee7a38",
            "name": "DPSK15",
            "passphrase": "cemqwzmzgit",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-12-06T07:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "vlanid": "44",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-4b67741c-5b87-48dc-b3c8-306f28ee7a38",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-4b67741c-5b87-48dc-b3c8-306f28ee7a38/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

Example of Creating a DPSK In an Existing DPSK Pool By Using a POST call

This example shows how to use a POST to create a new DPSK in an existing pool.

URI:

This example uses the following URI: 

 https://Jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks

where:

  • https://Jeff243.cloudpath.net/admin/apiv2 is the root URI of the Cloudpath system being used (must include https, as shown)
  • 5XcTc6SjkHDL is an example of an API key generated from the Configuration > API Keys section of the Cloudpath UI
  • AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8 is the GUID of the pool to which you are adding the new DPSK

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. 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 DPSK called "dpsk51" is being created with the values provided in the body. 

{
    "name":"dpsk51",
    "passphrase":"qsrmxldiecca",
    "status":"ACTIVE",
    "ssidList":[],
    "expirationDateTime":"2019-12-21T00:00-07:00[America/Denver]",
    "useDeviceCountLimit":true,
    "deviceCountLimit":7,
    "vlanid":"2",
    "overrideReauthentication":86400
}

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 DPSK) is included in the response body. 

{
    "guid": "AccountDpsk-0d37afce-84c5-4d42-9fc8-43c4f1d19b65",
    "name": "dpsk51",
    "passphrase": "qsrmxldiecca",
    "status": "ACTIVE",
    "ssidList": [],
    "expirationDateTime": "2020-12-21T07:00:00Z",
    "useDeviceCountLimit": true,
    "deviceCountLimit": 7,
    "deviceCount": 0,
    "vlanid": "2",
    "overrideReauthentication": 86400,
    "links": [
        {
            "rel": "self",
            "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-0d37afce-84c5-4d42-9fc8-43c4f1d19b65",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        },
        {
            "rel": "parent",
            "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        },
        {
            "rel": "devices",
            "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-0d37afce-84c5-4d42-9fc8-43c4f1d19b65/devices?page=1&pageSize=10{&filter,orderBy}",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        }
    ]
}

You can go to the Configuration > DPSK Pools area of the UI, and expand the pool to confirm that the DPSK was created correctly.

Example of Changing Page Properties in a GET Call

This example demonstrates how to change the page properties to display the response body of a GET call (where you are getting a complete list of items) as you choose. In the previous GET example, six DPSKs were listed on one page. The page information was displayed as the following: 

"page": {
        "page": 1,
        "pageSize": 6,
        "totalCount": 6

URI:

This example uses the following URI: 

 https://Jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/?pageSize=3&page=2

where:

  • https://Jeff243.cloudpath.net/admin/apiv2 is the root URI of the Cloudpath system being used (must include https, as shown)
  • 5XcTc6SjkHDL is an example of an API key generated from the Configuration > API Keys section of the Cloudpath UI
  • AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8 is the GUID of the DPSK pool from which you got a listing of all its DPSKs and their respective properties.
  • ?pageSize=3&page=2 denotes that you want three items per page in the GET response body, and you want only the page-2 information.

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:

No request body is needed

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 below lists the information based on how you used the page filters. As shown below, the page information reflects how it was specified in the URI, and the three Page 2 DPSKs are listed:

Note: One DPSK has been added to the pool since the original six DPSKs were shown earlier; this is reflected in the total count below showing as 7.

{
    "page": {
        "page": 2,
        "pageSize": 3,
        "totalCount": 7
    },
    "contents": [
        {
            "guid": "AccountDpsk-5ed29464-d571-48be-a0d0-7574ab87b93d",
            "name": "DPSK31",
            "passphrase": "jekgqviayiv",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-5ed29464-d571-48be-a0d0-7574ab87b93d",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-5ed29464-d571-48be-a0d0-7574ab87b93d/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-e7e2fe17-912d-4826-8010-05f3263f8fe8",
            "name": "DPSK32",
            "passphrase": "wilfyhhumqc",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e7e2fe17-912d-4826-8010-05f3263f8fe8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e7e2fe17-912d-4826-8010-05f3263f8fe8/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-fce6d0e6-19a1-464c-850c-31bde9472c52",
            "name": "DPSK33",
            "passphrase": "zygrjkezfry",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-fce6d0e6-19a1-464c-850c-31bde9472c52",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-fce6d0e6-19a1-464c-850c-31bde9472c52/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

Example of Filtering a GET Call

This example demonstrates how to filter a GET call by using a filter parameter. For a list of properties that support filters, and the filter operators that can be used on these properties, refer to Resource: DPSKs. Suppose you want to use "like" with the value of "3" to filter on only the DPSKs that have a "3" as part of their name property. You would add the following string to the URI: ?filter=name(like:3)

URI:

This example uses the following URI: 

 https://Jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/?filter=name(like:3)

where:

  • https://Jeff243.cloudpath.net/admin/apiv2 is the root URI of the Cloudpath system being used (must include https, as shown)
  • 5XcTc6SjkHDL is an example of an API key generated from the Configuration > API Keys section of the Cloudpath UI
  • AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8 is the GUID of the DPSK pool from which you want a listing of the DPSKs that match the filter criteria that you append to the URI.
  • ?filter=name(like:3) is the filter criteria that denotes that you want to display only those DPSKs that contain the numeral "3" in their name.

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:

No request body is needed

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 below lists the information based on how you used the filters. As shown below, all the DPSKs listed contain the numeral "3" in their name: 

{
    "page": {
        "page": 1,
        "pageSize": 5,
        "totalCount": 5
    },
    "contents": [
        {
            "guid": "AccountDpsk-e45f6b14-2cff-4c8d-b44e-102fd67fe02c",
            "name": "DPSK23",
            "passphrase": "xzhjmjzdaoo",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e45f6b14-2cff-4c8d-b44e-102fd67fe02c",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e45f6b14-2cff-4c8d-b44e-102fd67fe02c/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-bc993a37-05f4-4a39-8fe3-6a888b35f2c1",
            "name": "DPSK30",
            "passphrase": "uoosztyuoel",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-bc993a37-05f4-4a39-8fe3-6a888b35f2c1",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-bc993a37-05f4-4a39-8fe3-6a888b35f2c1/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-5ed29464-d571-48be-a0d0-7574ab87b93d",
            "name": "DPSK31",
            "passphrase": "jekgqviayiv",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-5ed29464-d571-48be-a0d0-7574ab87b93d",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-5ed29464-d571-48be-a0d0-7574ab87b93d/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-e7e2fe17-912d-4826-8010-05f3263f8fe8",
            "name": "DPSK32",
            "passphrase": "wilfyhhumqc",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e7e2fe17-912d-4826-8010-05f3263f8fe8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e7e2fe17-912d-4826-8010-05f3263f8fe8/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-fce6d0e6-19a1-464c-850c-31bde9472c52",
            "name": "DPSK33",
            "passphrase": "zygrjkezfry",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-fce6d0e6-19a1-464c-850c-31bde9472c52",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-fce6d0e6-19a1-464c-850c-31bde9472c52/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

Example of Sorting a GET Call

This example demonstrates how to sort a GET call by using the sortBy parameter. For a list of properties that support sorting, refer to Resource: DPSKs. Suppose you want to sort on the name of the DPSK, in descending order. You would add the following string to the URI: ?sortBy=name:desc

URI:

This example uses the following URI: 

 https://Jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/?sortBy=name:desc

where:

  • https://Jeff243.cloudpath.net/admin/apiv2 is the root URI of the Cloudpath system being used (must include https, as shown)
  • 5XcTc6SjkHDL is an example of an API key generated from the Configuration > API Keys section of the Cloudpath UI
  • AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8 is the GUID of the DPSK pool from which you want to sort the DPSKs by adding sorting criteria to the URI.
  • ?sortBy=name:desc is the sorting criteria that denotes that you want to display DPSKs by name, in descending order.

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:

No request body is needed

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 below lists the information based on how you used the sortBy parameter. As shown below, the DPSKs have been sorting by name in descending order.

Note: One DPSK has been added to the pool since the original six DPSKs were shown earlier; this is reflected in the total count below showing as 7.

{
    "page": {
        "page": 1,
        "pageSize": 7,
        "totalCount": 7
    },
    "contents": [
        {
            "guid": "AccountDpsk-0d37afce-84c5-4d42-9fc8-43c4f1d19b65",
            "name": "dpsk51",
            "passphrase": "qsrmxldiecca",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-12-21T07:00:00Z",
            "useDeviceCountLimit": true,
            "deviceCountLimit": 7,
            "deviceCount": 0,
            "vlanid": "2",
            "overrideReauthentication": 86400,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-0d37afce-84c5-4d42-9fc8-43c4f1d19b65",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-0d37afce-84c5-4d42-9fc8-43c4f1d19b65/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-e45f6b14-2cff-4c8d-b44e-102fd67fe02c",
            "name": "DPSK23",
            "passphrase": "xzhjmjzdaoo",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e45f6b14-2cff-4c8d-b44e-102fd67fe02c",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e45f6b14-2cff-4c8d-b44e-102fd67fe02c/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-bc993a37-05f4-4a39-8fe3-6a888b35f2c1",
            "name": "DPSK30",
            "passphrase": "uoosztyuoel",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-bc993a37-05f4-4a39-8fe3-6a888b35f2c1",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-bc993a37-05f4-4a39-8fe3-6a888b35f2c1/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-5ed29464-d571-48be-a0d0-7574ab87b93d",
            "name": "DPSK31",
            "passphrase": "jekgqviayiv",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-5ed29464-d571-48be-a0d0-7574ab87b93d",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-5ed29464-d571-48be-a0d0-7574ab87b93d/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-e7e2fe17-912d-4826-8010-05f3263f8fe8",
            "name": "DPSK32",
            "passphrase": "wilfyhhumqc",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e7e2fe17-912d-4826-8010-05f3263f8fe8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-e7e2fe17-912d-4826-8010-05f3263f8fe8/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-fce6d0e6-19a1-464c-850c-31bde9472c52",
            "name": "DPSK33",
            "passphrase": "zygrjkezfry",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-07-27T06:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-fce6d0e6-19a1-464c-850c-31bde9472c52",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-fce6d0e6-19a1-464c-850c-31bde9472c52/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "AccountDpsk-4b67741c-5b87-48dc-b3c8-306f28ee7a38",
            "name": "DPSK15",
            "passphrase": "cemqwzmzgit",
            "status": "ACTIVE",
            "ssidList": [],
            "expirationDateTime": "2020-12-06T07:00:00Z",
            "useDeviceCountLimit": false,
            "deviceCountLimit": 0,
            "deviceCount": 0,
            "vlanid": "44",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-4b67741c-5b87-48dc-b3c8-306f28ee7a38",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "parent",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "devices",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/dpskPools/AccountDpskPool-14dc1ed8-ba2a-43bd-8cad-e30dc5f20fb8/dpsks/AccountDpsk-4b67741c-5b87-48dc-b3c8-306f28ee7a38/devices?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

Parent topic: DSPK Resources and URIs