Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesPsks

listSitePsks

GET
/api/v1/sites/{site_id}/psks

Get List of Site PSKs

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

site_id*string
Formatuuid

Query Parameters

ssid?string

Filter results by SSID

role?string

Filter PSK results by role

name?string

Filter results by name

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/psks"
[  {    "created_time": 0,    "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "mac": "string",    "modified_time": 0,    "name": "string",    "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "passphrase": "secretpsk",    "site_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "ssid": "string",    "usage": "multi",    "vlan_id": 1  }]

listSiteNetworksDerived GET

Get the list of derived Networks for a Site

createSitePsk POST

Create Site PSK When `usage`==`macs`, corresponding "macs" field will hold a list consisting of client MAC addresses (["xx:xx:xx:xx:xx",...]) or mac patterns(["xx:xx:*","xx*",...]) or both (["xx:xx:xx:xx:xx:xx", "xx:*", ...]). This list is capped at 5000