getSitePskDetails
GET https://{{host}}/api/v1/sites/:site_id/psks/:psk_id
Response Parameter
Name | Type | Description |
---|---|---|
name | string | a name for the PSK |
passphrase | string | passphrase of the PSK (8-63 character or 64 in hex) |
ssid | string | SSID this PSK should be applicable to |
usage | string | multi (default) / single |
vlan_id | int | VLAN for this PSK key |
mac | string | if usage==single, the mac that this PSK ties to, empty if auto-binding |
expire_time | int | default is half year, max is 5 year |
notes | string | notes |
notify_expiry | boolean | If set to true, reminder notification will be sent when psk is about to expire |
expiry_notification_time | int | Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire |
notify_on_create_or_edit | boolean | If set to true, notification will be sent when psk is created or edited |
email | string | Email to send psk expiring notifications to |
RESPONSES
status: OK
{"name":"Common","passphrase":"foryoureyesonly","ssid":"warehouse","usage":"single","vlan_id":417,"mac":"5684dae9ac8b","expire_time":1614990263,"notes":"notes","notify_expiry":true,"expiry_notification_time":2,"notify_on_create_or_edit":true,"email":"admin@test.com"}