importOrgPskJson
POST https://{{host}}/api/v1/orgs/:org_id/psks/import
Definitions
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 |
max_usage | int | max concurrent users for this PSK key. Default is 0 (unlimited) |
role | string | Role for this PSK key (32 character maximum) |
expire_time | int | Expire time for this PSK key. Default is half year, max is 5 year |
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 |
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*"]}}
Key | Datatype | Required | Description |
---|
Accept | string | | |
X-CSRFToken | string | | |
Content-Type | string | | |