createSitePsk
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
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
uuidRequest Body
application/json
Request Body
Personal pre-shared key configuration for WLAN access
Notification recipient email address for PSK creation notification and expiration reminders
Expire time for this PSK key (epoch time in seconds). Default null (as no expiration)
nullNumber of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire
If usage==single, client MAC address this PSK is bound to; empty when auto-binding is used
Client MAC addresses or MAC patterns allowed when usage==macs
For Org PSK Only. Max concurrent users for this PSK key. Default is 0 (unlimited)
0Display name of the PSK
Admin note or description stored with the PSK
If set to true, reminder notification will be sent when psk is about to expire
falseIf set to true, notification will be sent when psk is created or edited
previous passphrase of the PSK if it has been rotated
PSK passphrase, 8-63 characters or 64 hexadecimal characters
password8 <= length <= 64Client role applied to users authenticated with this PSK
0 <= length <= 32WLAN SSID where this PSK can be used
Binding mode for this PSK, enum: macs, multi, single, usermac_labels
"multi"Value in
- "macs"
- "multi"
- "single"
- "usermac_labels"
Usermac labels allowed when usage==usermac_labels; this list is capped at 100 entries
items <= 100VLAN ID returned for clients using this PSK
VLAN name to be assigned. Optional, vlan_id takes precedence if both are provided
Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/psks" \ -H "Content-Type: application/json" \ -d '{ "mac": "string", "name": "string", "passphrase": "secretpsk", "ssid": "string", "usage": "multi", "vlan_id": 1 }'{ "admin_sso_id": "string", "created_time": 0.1, "email": "string", "expire_time": 1614990263, "expiry_notification_time": 0, "id": "53f10664-3ce8-4c27-b382-0ef66432349f", "mac": "string", "macs": [ "112233abcedf", "aabbcc*" ], "max_usage": 0, "modified_time": 0.1, "name": "string", "note": "string", "notify_expiry": false, "notify_on_create_or_edit": true, "old_passphrase": "string", "org_id": "a97c1b22-a4e9-411e-9bfd-d8695a0f9e61", "passphrase": "pa$$word", "role": "string", "site_id": "441a1214-6928-442a-8e92-e1d34b8ec6a6", "ssid": "string", "usage": "macs", "usermac_labels": [ "iot", "students" ], "vlan_id": "string", "vlan_name": "string"}