- All requests to the API require your SmartWiFi API Token.
- All requests are done via HTTPS and depending on the environment will use one of the following hostnames.
You can confirm your environment under Operator Customizations.US-A Environmentapi.smartwifiplatform.comBapi-usb.smartwifiplatform.com - All responses contain JSON.
Path: /v2/zapier/dropdown/clients Example response:
Description: Returns a list of clients associated with the Operator API token.
Example Request:curl --location --request GET 'https://api.smartwifiplatform.com/v2/zapier/dropdown/clients' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
}'
[
{
"id": 12734,
"company": "ExampleCompany1"
},
{
"id": 15343,
"company": "ExampleCompany2"
},
{
"id": 19648,
"company": "ExampleCompany3"
}
]
Path: /v3/client_usage
Description: Returns the usage data for the specified Client.
Example Request:
curl --location --request GET 'https://api.smartwifiplatform.com/v3/client_usage' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86
", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1
", "client_id": 1x7, "month": 11, "year": 2022 }'
Example response:
[ { "month": 11, "year": 2022, "client_id": 1x7, "guests": 26, "sessions": 52, "sms_sent": 0, "smart_campaigns": 181, "scheduled_campaigns": 27, "contacts": 260787, "hotspots": 0, "new_hotspots": 0, "controllers": 0, "new_controllers": 0, "guest_plans": 0, "transactions": 0, "create_date": "2022-12-27T19:56:07.651958+00:00", "last_modifed": null } ]
Path: /v2/zapier/clients
Description: Returns a list of clients associated with the operator api token, billing system id, and admin contact information.
Example Request:
curl --location --request GET 'https://api.smartwifiplatform.com/v2/zapier/clients' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
}'
Example response:
[ { "id": 12734, "company": "ExampleCompany1", "billing_system_id": 26565, "admin_contact_name": TestAdmin, "admin_contact_email": testadmin@email.com, "admin_contact_phone": 1234567890 }, { "id": 15343, "company": "ExampleCompany2", "billing_system_id": 26566, "admin_contact_name": TestAdmin, "admin_contact_email": testadmin@email.com, "admin_contact_phone": 1234567890 }, { "id": 19648, "company": "ExampleCompany3", "billing_system_id": 26567, "admin_contact_name": TestAdmin, "admin_contact_email": testadmin@email.com, "admin_contact_phone": 1234567890 } ]
Path: /v2/zapier/hotspots
Description: Returns a list of hotspots associated with the operator api token, the client it is assign to, and the category it belongs in.
Example request:
curl --location --request GET 'https://api.smartwifiplatform.com/v2/zapier/hotspots' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
}'
Example response:
[ { "id": 24115, "name": "TestHotspot", "address": "123 Test st.", "nasidentifier": "XXXX", "venuename": "test", "phone": 1234567890, "city": "TestCity", "state": "TestState", "postal_code": "90210", "country": TestCountry, "lat": null, "long": null, "enabled": true, "client": { "id": 12734, "company": "ExampleCompany1", "billing_system_id": 26565, "admin_contact_name": TestAdmin, "admin_contact_email": testadmin@email.com, "admin_contact_phone": 1234567890 }, "categories": [ { "id": 1, "label": "Airport" } ] } ]
Path: /v3/clients/plans
Description: Returns a list of the plan templates associated with the Operator dashboard.
Example request:
curl --location --request GET 'https://api.smartwifiplatform.com/v3/clients/plans' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86
", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1
" }'
Example response:
[ { "id": 20, "plan": "Bronze" }, { "id": 28, "plan": "Silver" }, { "id": 27, "plan": "Gold" }, { "id": 29, "plan": "Enterprise" } ]
Path: /v3/clients
Description: Creates a Client in the Operator dashboard.
Available Parameters:
JSON Field name | Required | Type |
---|---|---|
token | Yes | string |
secret | Yes | string |
company | No | string |
billing_id | No | string |
template | No | int |
included_mdc | No | int |
included_unique_guests | No | int |
included_sms | No | int |
included_contacts | No | int |
included_scheduled_campaign_messages | No | int |
phone | No | string |
website_url | No | string |
admin_contact_name | No | string |
admin_contact_email | No | string |
admin_contact_phone | No | string |
enable_ads4wifi | No | bool |
enable_api | No | bool |
enable_presence | No | bool |
enable_payments | No | bool |
enable_vouchers | No | bool |
enable_sms | No | bool |
enable_marketing_campaigns | No | bool |
enable_integrations | No | bool |
enable_redirect_modification | No | bool |
enable_contact_manager | No | bool |
Example Request:
curl --location --request POST 'https://api.smartwifiplatform.com/v2/clients' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1", "billing_ID": "2xx9", "company": "My Company",
"template": 5
}'
Example response:
{ "client_id": "2x1" }
Path: /v3/client/{client_id}
Description: Edits a Client in the Operator dashboard.
Available Parameters:
JSON Field name | Required | Type |
---|---|---|
token | Yes | string |
secret | Yes | string |
company | No | string |
billing_id | No | string |
template | No | int |
included_mdc | No | int |
included_unique_guests | No | int |
included_sms | No | int |
included_contacts | No | int |
included_scheduled_campaign_messages | No | int |
phone | No | string |
website_url | No | string |
admin_contact_name | No | string |
admin_contact_email | No | string |
admin_contact_phone | No | string |
enable_ads4wifi | No | bool |
enable_api | No | bool |
enable_presence | No | bool |
enable_payments | No | bool |
enable_vouchers | No | bool |
enable_sms | No | bool |
enable_marketing_campaigns | No | bool |
enable_integrations | No | bool |
enable_redirect_modification | No | bool |
enable_contact_manager | No | bool |
Example Request:
curl --location --request PUT 'https://api.smartwifiplatform.com/v2/client/2x1' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1", "enable_marketing_campaigns": true
}'
Example response:
{ "id": 2x1, "billing_id": "1234567", "company": "Demo Client", "template": 27, "included_mdc": 0, "included_unique_guests": 1, "included_sms": 0, "included_contacts": 1, "included_scheduled_campaign_messages": 0, "phone": null, "website_url": null, "admin_contact_name": null, "admin_contact_email": null, "admin_contact_phone": null, "enable_ads4wifi": false, "enable_api": true, "enable_presence": true, "enable_payments": true, "enable_vouchers": true, "enable_sms": true, "enable_marketing_campaigns": true, "enable_integrations": false, "enable_redirect_modification": true, "enable_contact_manager": false }
Path: /v3/client/{client_id}
Description: Returns the details of the specified Client.
Example Request:
curl --location --request GET 'https://api.smartwifiplatform.com/v3/client/{client_id}' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
"secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1"
}'
Example response:
{ "id": 2x1, "billing_id": "1234567", "company": "Demo Client", "template": 27, "included_mdc": 0, "included_unique_guests": 1, "included_sms": 0, "included_contacts": 1, "included_scheduled_campaign_messages": 0, "phone": null, "website_url": null, "admin_contact_name": null, "admin_contact_email": null, "admin_contact_phone": null, "enable_ads4wifi": false, "enable_api": true, "enable_presence": true, "enable_payments": true, "enable_vouchers": true, "enable_sms": true, "enable_marketing_campaigns": true, "enable_integrations": false, "enable_redirect_modification": true, "enable_contact_manager": false }
Path: /v3/clients/suspend
Description: Suspends a Client in the Operator dashboard.
Example Request:
curl --location --request PUT 'https://api.smartwifiplatform.com/v3/clients/suspend' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
"secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",
"client_id": 2x1 }'
Example response:
{ "client_id": "2x1", "client_status": "suspended" }
Path: /v3/clients/suspend
Description: Activate a suspended Client in the Operator dashboard.
Example Request:
curl --location --request PUT 'https://api.smartwifiplatform.com/v3/clients/unsuspend' \ --header 'Content-Type: application/json' \ --data-raw '{"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",
"client_id": 2x1 }'
Example response:
{"client_id": "2x1",
"client_status": "active" }
Path: /v3/menu_items
Description: Returns a list of the possible user_access and user_visibility parameters used for creating and editing Client users.
Example Request:
curl --location --request GET 'https://api.smartwifiplatform.com/v3/menu_items' \ --header 'Content-Type: application/json' \ --data-raw '{"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1"
'
Example response:
[ { "id": 44, "title": "Client Settings", "sub_menu": [ { "id": 45, "title": "Client Profile", "sub_menu": null }, { "id": 46, "title": "Client Customizations", "sub_menu": null }, { "id": 47, "title": "SMTP Server", "sub_menu": null }, { "id": 62, "title": "Add/Edit Users", "sub_menu": [ { "id": 63, "title": "Manage Users" } ] } ] }, { "id": 1, "title": "Network", "sub_menu": [ { "id": 51, "title": "Hotspots", "sub_menu": [ { "id": 56, "title": "Manage Hotspot" } ] }, { "id": 73, "title": "Guests", "sub_menu": null }, { "id": 79, "title": "Guest Plans", "sub_menu": [ { "id": 80, "title": "Manage Guest Plans" } ] }, { "id": 77, "title": "Guest Flows", "sub_menu": [ { "id": 78, "title": "Manage Guest Flow" } ] }, { "id": 81, "title": "Vouchers", "sub_menu": null }, { "id": 57, "title": "Splash Pages", "sub_menu": [ { "id": 58, "title": "Manage Splash Page" } ] } ] }, { "id": 86, "title": "Contact Manager", "sub_menu": [ { "id": 87, "title": "Contacts", "sub_menu": [ { "id": 100, "title": "Contact Profile" }, { "id": 96, "title": "Manage Contact" }, { "id": 97, "title": "Import Contact" } ] }, { "id": 88, "title": "Tags", "sub_menu": null }, { "id": 95, "title": "Sched. Campaign Logs", "sub_menu": null }, { "id": 98, "title": "Guest to Contact Sync", "sub_menu": [ { "id": 99, "title": "Manage Sync" } ] }, { "id": 109, "title": "Audiences", "sub_menu": null } ] }, { "id": 17, "title": "Reports", "sub_menu": [ { "id": 104, "title": "ROI Calculator", "sub_menu": null }, { "id": 18, "title": "Guest Connections", "sub_menu": null }, { "id": 35, "title": "Connection Summary", "sub_menu": null }, { "id": 37, "title": "Guest Summary", "sub_menu": null }, { "id": 82, "title": "Revenue Report", "sub_menu": null }, { "id": 38, "title": "Gateway Status", "sub_menu": null }, { "id": 60, "title": "SMS Report", "sub_menu": null }, { "id": 71, "title": "Unsubscribe Report", "sub_menu": null }, { "id": 89, "title": "Contact Summary", "sub_menu": null }, { "id": 94, "title": "Contact Tag Summary", "sub_menu": null }, { "id": 101, "title": "Campaign Summary", "sub_menu": null } ] }, { "id": 53, "title": "Insights", "sub_menu": [ { "id": 54, "title": "Hotspot Insights", "sub_menu": null }, { "id": 55, "title": "Guest Insights", "sub_menu": null }, { "id": 70, "title": "Campaign Insights", "sub_menu": null } ] }, { "id": 21, "title": "Marketing", "sub_menu": [ { "id": 22, "title": "Campaigns", "sub_menu": [ { "id": 23, "title": "Add Rule" } ] }, { "id": 74, "title": "Campaign Templates", "sub_menu": [ { "id": 75, "title": "Add Templates" } ] }, { "id": 33, "title": "Campaign Logs", "sub_menu": null } ] }, { "id": 65, "title": "Coupons", "sub_menu": [ { "id": 66, "title": "Campaigns", "sub_menu": [ { "id": 68, "title": "Manage Campaigns" } ] }, { "id": 69, "title": "Campaign Logs", "sub_menu": null } ] }, { "id": 24, "title": "Integrations", "sub_menu": [ { "id": 25, "title": "Mailer Apps", "sub_menu": [ { "id": 26, "title": "Add Rule" } ] }, { "id": 84, "title": "Other Apps", "sub_menu": null } ] }, { "id": 15, "title": "Billing", "sub_menu": null }, { "id": 16, "title": "Client Support", "sub_menu": null } ]
Path: /v3/email_report_types
Description: Returns a list of the Client User Email report parameters used for creating and editing Client users.
Example Request:
curl --location --request GET 'https://api.smartwifiplatform.com/v3/email_report_types' \ --header 'Content-Type: application/json' \ --data-raw '{"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1"
'
Example response:
[ { "id": 21, "name": "ROI Monthly Email Report", "reportid": 7 }, { "id": 16, "name": "Guest Connections", "reportid": 2 }, { "id": 17, "name": "Weekly Summary Report 1", "reportid": 3 }, { "id": 18, "name": "Weekly Report Summary 2", "reportid": 5 }, { "id": 19, "name": "Gateway Alerts", "reportid": 6 }, { "id": 27, "name": "Client Use Green to Yellow", "reportid": 8 }, { "id": 28, "name": "Client Use Yellow to Red", "reportid": 9 } ]
Path: /v3/clientusers
Description: Create a Client user in the Operator dashboard.
Available Parameters:
JSON Field Name | Required | Type |
---|---|---|
token | Yes | String |
secret | Yes | String |
client_id | Yes | int |
username | Yes | String |
password | Yes | String |
Yes | String | |
template | No | int |
user_access | No | int |
user_visibility | No | int |
email_report | No | int |
Example Request:
curl --location --request POST 'https://api.smartwifiplatform.com/v3/clientusers' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
"secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",
"client_id": 2x1, "username": "DemoUser", "password": "GuestPassword", "email": "demo@example.com", "template": 5 }'
Example response:
{ "client_user_id": "1x9", }
Path: /v3/clientuser/{client_user_id}
Description: Edit a Client user in the Operator dashboard.
Available Parameters:
JSON Field Name | Required | Type |
---|---|---|
token | Yes | String |
secret | Yes | String |
password | No | String |
user_access | No | int |
user_visibility | No | int |
email_report | No | int |
Example Request:
curl --location --request PUT 'https://api.smartwifiplatform.com/v3/clientuser/{client_user_id}' \ --header 'Content-Type: application/json' \ --data-raw '{"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",
"password": "GuestPassword","user_access":
[44,45,46,47,62,63],
"user_visibility": [44,45,46,47,62,63],
"email_report": [1,2,6,7]
}'
Example response:
coming soon
Path: /v3/clientuser/{client_user_id}
Description: Returns the details of the specified Client user.
Available Parameters:
JSON Field Name | Required | Type |
---|---|---|
token | Yes | String |
secret | Yes | String |
Example Request:
curl --location --request GET 'https://api.smartwifiplatform.com/v3/clientuser/{client_user_id}' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
"secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1"
}'
Example response:
{ "id": 209, "client_id": 2x1, "username": "demouser", "email": "myuser@demo.com", "template": null, "user_access": [ 1, 15, 16, 17, 37, 38, 44, 45, 51, 56, 62, 63 ], "user_visibility": [ 1, 15, 16, 17, 18, 21, 22, 23, 24, 25, 26, 33, 35, 37, 38, 44, 75 ], "email_report": [ 1 ] }
Path: /v3/clients/id
Description: Returns the Client ID of a Client based on their billing ID.
Example Request:
curl --location --request GET 'https://api.smartwifiplatform.com/v3/clients/id' \ --header 'Content-Type: application/json' \ --data-raw '{"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",
"billing_id":2xx9
}'
Example response:
{ "client_id": "2x1" }
Path: /v3/hotspots
Description: Returns a list of hotspot IDs and their name.
Example Request:
curl --location --request GET 'https://api.smartwifiplatform.com/v3/hotspots' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
"secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",
"client_id": 2x1 }'
Example response:
[ { "id": 3x0, "name": "Demo Hotspot" } ]
Path: /v3/hotspots
Description: Create a hotspot under the specified Client.
Example Request:
curl --location --request POST 'https://api.smartwifiplatform.com/v3/hotspots' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
"secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",
"client_id": 2x1, "name": "Demo Hotspot", "venue": "My Venue", "address": "Address", "city": "city", "state": "state", "zipcode": "zipcode", "country": "country", "phone": "phone", "redirect_url": "https://google.com", "nasid": "gwCtosroY", "nas_secret": "gwCtosroY" }'
Example response:
{ "hotspot_id": "3x0" }
Path: /v3/hotspots/enable
Description: Enable a hotspot under the specified Client.
Example Request:
curl --location --request PUT 'https://devapi.smartwifiplatform.com/v3/hotspots/enable' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86
", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1
", "client_id": 2x1, "hotspot_id": 3x0 }'
Example response:
{ "hotspot_id": "3x0", "hotspot_status": "enabled" }
Path: /v3/controllerTypes
Description: Returns the current list of controller types and their ID.
Example Request:
curl --location --request GET 'https://api.smartwifiplatform.com/v3/controllerTypes' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86
", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1
" }'
Example response:
{ "id": "5", "name": "Ruckus SCG & vSZ" }
Path: /v3/gettimezones
Description: Returns a list of timezones and their identifier.
Example Request:
curl --location --request GET 'https://api.smartwifiplatform.com/v3/gettimezones' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86
", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1
" }'
Example response:
[ { "id": 303, "zone_name": "America/New_York" }, ]
Path: /v3/controllers
Description: Returns the list of Gateways under a specified client hotspot.
Example Request:
curl --location --request GET 'https://api.smartwifiplatform.com/v3/controllers' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86
", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1
", "client_id": 1x7, "hotspot_id": 2x2 }'
Example response:
[ { "id": 22965, "name": "Demo Gateway", "macaddress": "7x:4x:2x:Dx:0x:Cx" }, ]
Path: /v3/controllers
Description: Create a controller under the specified Hotspot.
Available Parameters:
Controller Type ID | Attribute | Required | Example |
---|---|---|---|
all | token | Yes | string |
all | secret | Yes | string |
all | client_id | Yes | numeric |
all | hotspot_id | Yes | numeric |
all | controller_type_id | Yes | numeric |
all | name | Yes | string |
2 | cloudtrax_script | No | string |
4 | domain_id | Yes | numeric |
4 | ip_address | Yes | string |
5 | nbipassword | Yes | string |
5 | nbiusername | No | string |
5 | ip_mapping: | No | string |
6 | bridge | No | true/false |
6 | isolation | No | true/false |
6 | wlan2 | No | true/false |
6 | primary_dns | No | string |
6 | secondary_dns | No | string |
7 | ssid | No | string |
7 | bridge | No | bool |
7 | isolation | No | bool |
7 | wlan2 | No | bool |
7 | primary_dns | No | string |
7 | secondary_dns | No | string |
20 | mist_api_secret | Yes | string |
20 | mist_side_id | Yes | string |
20 | mist_api_token | Yes | string |
23 | nbipassword | No | string |
29 | unifi_api_url | Yes | string |
29 | unifi_api_username | Yes | string |
29 | unifi_api_password | Yes | string |
29 | unifi_api_site | Yes | string |
29 | unifi_connection_terminate | No | bool |
Example Request:
curl --location --request POST 'https://api.smartwifiplatform.com/v3/controllers' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
"secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",
"client_id": 2x1, "hotspot_id": 1x3, "controller_type_id": 3, "name": "My Controller", "mac_address": "AA:BB:CC:11:22:33" }'
Example response:
{ "controller_id": "23xx0" }
Path: /v3/controller/{{controller_id}}
Description: Edit an existing controller by using it’s controller ID.
Available parameters:
Controller Type ID | Attribute | Required | Example |
---|---|---|---|
all | token | Yes | string |
all | secret | Yes | string |
all | client_id | Yes | numeric |
all | hotspot_id | Yes | numeric |
all | controller_type_id | Yes | numeric |
all | name | Yes | string |
2 | cloudtrax_script | No | string |
4 | domain_id | Yes | numeric |
4 | ip_address | Yes | string |
5 | nbipassword | Yes | string |
5 | nbiusername | No | string |
5 | ip_mapping: | No | string |
6 | bridge | No | true/false |
6 | isolation | No | true/false |
6 | wlan2 | No | true/false |
6 | primary_dns | No | string |
6 | secondary_dns | No | string |
7 | ssid | No | string |
7 | bridge | No | bool |
7 | isolation | No | bool |
7 | wlan2 | No | bool |
7 | primary_dns | No | string |
7 | secondary_dns | No | string |
20 | mist_api_secret | Yes | string |
20 | mist_side_id | Yes | string |
20 | mist_api_token | Yes | string |
23 | nbipassword | No | string |
29 | unifi_api_url | Yes | string |
29 | unifi_api_username | Yes | string |
29 | unifi_api_password | Yes | string |
29 | unifi_api_site | Yes | string |
29 | unifi_connection_terminate | No | bool |
Example Request:
curl --location --request PUT 'https://api.smartwifiplatform.com/v3/controller/[controller_id]' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
"secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",
"client_id": 2x1, "hotspot_id": 1x3, "controller_type_id": 3, "name": "Demo Controller", "mac_address": "AA:BB:CC:11:22:33" }'
Example response:
{ "controller_id": "23xx0" }