importOrgPskJson

POST https://{{host}}/api/v1/orgs/:org_id/psks/import

Definitions

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
max_usageintmax concurrent users for this PSK key. Default is 0 (unlimited)
rolestringRole for this PSK key (32 character maximum)
expire_timeintExpire time for this PSK key. Default is half year, max is 5 year
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

Request Body

{"0"=>{"name"=>"Common", "ssid"=>"warehouse", "passphrase"=>"foryoureyesonly", "usage"=>"single", "vlan_id"=>35, "mac"=>"a31425f31278", "max_usage"=>300, "role"=>"teacher", "expire_time"=>"1618594236", "notify_expiry"=>true, "expiry_notification_time"=>2, "notify_on_create_or_edit"=>true, "email"=>"admin@test.com"}, "1"=>{"name"=>"Justin", "ssid"=>"reception", "passphrase"=>"visible", "usage"=>"multi", "vlan_id"=>1002, "mac"=>nil}, "2"=>{"name"=>"Alice", "ssid"=>"guest", "passphrase"=>"visible", "usage"=>"macs", "vlan_id"=>1002, "macs"=>["11:22:33:44:55:66", "aa:bb:cc*"]}}

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
X-CSRFTokenstring
Content-Typestring