Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsPsks

listOrgPsks

GET
/api/v1/orgs/{org_id}/psks

List organization personal PSKs for WLAN access, optionally filtering by name, SSID, or role.

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

org_id*string
Formatuuid

Query Parameters

name?string

Filter results by name. Accepts multiple comma-separated values.

ssid?string

Filter results by SSID. Accepts multiple comma-separated values.

role?string

Filter PSK results by role. Accepts multiple comma-separated values.

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/orgs/000000ab-00ab-00ab-00ab-0000000000ab/psks?name=psk-a%2Cpsk-b"
[  {    "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  }]

updateOrgPskPortalTemplate PUT

Update PSK Portal UI template settings, including alignment, color, logo, Powered by visibility, and Terms of Service text.

createOrgPsk POST

Create an organization personal PSK for WLAN access, including SSID, passphrase, usage mode, optional client MAC binding, role, VLAN, and expiration settings. 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