getSitePskDetails

GET https://{{host}}/api/v1/sites/:site_id/psks/:psk_id

Response Parameter

NameTypeDescription
namestringa name for the PSK
passphrasestringpassphrase of the PSK (8-63 character or 64 in hex)
ssidstringSSID this PSK should be applicable to
usagestringmulti (default) / single
vlan_idintVLAN for this PSK key
macstringif usage==single, the mac that this PSK ties to, empty if auto-binding
expire_timeintdefault is half year, max is 5 year
notesstringnotes
notify_expirybooleanIf set to true, reminder notification will be sent when psk is about to expire
expiry_notification_timeintNumber 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_editbooleanIf set to true, notification will be sent when psk is created or edited
emailstringEmail 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"}