Documentation for Dashboard API
- Retrieve Brand Settings
https://api.ruckus.cloud/
https://api.eu.ruckus.cloud/
https://api.asia.ruckus.cloud/
- RUCKUS One API host for North American region.
https://api.ruckus.cloud/brandings
- RUCKUS One API host for European region.
https://api.eu.ruckus.cloud/brandings
- RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud/brandings
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payload
Ok
- application/json
- application/vnd.ruckus.v1+json
The UUID of alarm notification logo file.
The UUID of ping notification logo file.
The UUID of Ruckus Analytics logo file.
The UUID of ping login logo file.
The UUID of default logo file.
The URL at which to obtain customer support from your MSP.
The contact support behavior of MSP tenant.
The URL at which to open a customer support case with your MSP.
The URL to view your open customer support cases.
The change password URL of MSP tenant.
{ "msp_label": "msp-label", "logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg", "alarm_notification_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg", "ping_notification_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg", "mlisa_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg", "ping_login_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg", "default_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg", "msp_fqdn": "wifi.sampledomain.com", "contact_support_url": "http://support.sampledomain.com/", "contact_support_behavior": "redirect", "open_case_url": "http://support.sampledomain.com/opencase", "open_case_behavior": "redirect", "my_open_case_url": "http://support.sampledomain.com/myopencase", "my_open_case_behavior": "redirect", "change_password_url": "http://wifi.sampledomain.com/password", "msp_phone": "+6501234567", "msp_email": "support@msp.com", "msp_website": "http://wifi.sampledomain.com", "msp_external_id": "0015B000015bJEfQAM", "msp_tenant_name": "sampledomain Inc.", "mspLogoFileDataList": [ { … } ], "preferredWisprProvider": { "id": "string", "createdDate": "2019-08-24T14:15:22Z", "updatedDate": "2019-08-24T14:15:22Z", "providerName": "string", "apiKey": "string", "apiSecret": "string", "customExternalProvider": true, "auth": { … }, "acct": { … }, "parentId": "string" }, "domain_suffix": "string" }
- application/json
- application/vnd.ruckus.v1+json
The ID of logo file.
The ID of alarm notification logo file.
The ID of ping notification logo file.
The ID of Ruckus Analytics logo file.
The ID of ping login logo file.
The ID of default logo file.
The FQDN of MSP portal.
The URL at which to obtain customer support from your MSP.
The contact support behavior of MSP tenant.
The URL at which to open a customer support case with your MSP.
The open case behavior of MSP tenant.
The URL to view your open customer support cases.
The my open case behavior of MSP tenant.
The change password URL of MSP tenant.
Your MSP's customer-support phone number.
Your MSP's customer-support email address.
Your MSP's website.
- RUCKUS One API host for North American region.
https://api.ruckus.cloud/brandings
- RUCKUS One API host for European region.
https://api.eu.ruckus.cloud/brandings
- RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud/brandings
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "msp_label": "msp-label", "logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "alarm_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "ping_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "mlisa_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "ping_login_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "default_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "msp_fqdn": "wifi.sampledomain.com", "contact_support_url": "https://support.sampledomain.com/", "contact_support_behavior": "redirect", "open_case_url": "http://support.sampledomain.com/opencase", "open_case_behavior": "redirect", "my_open_case_url": "http://support.sampledomain.com/myopencase", "my_open_case_behavior": "redirect", "change_password_url": "http://wifi.sampledomain.com/password", "msp_phone": "408-123-5678", "msp_email": "joho.wang@sampledomain.com", "msp_website": "http://wifi.sampledomain.com/", "mspLogoFileDataList": [ { … } ], "preferredWisprProvider": { "id": "string", "createdDate": "2019-08-24T14:15:22Z", "providerName": "string", "apiKey": "string", "apiSecret": "string", "customExternalProvider": true, "auth": { … }, "acct": { … } } }
{ "requestId": "string", "tenantId": "string" }
- application/json
- application/vnd.ruckus.v1+json
The ID of logo file.
The ID of alarm notification logo file.
The ID of ping notification logo file.
The ID of Ruckus Analytics logo file.
The ID of ping login logo file.
The ID of default logo file.
The FQDN of MSP portal.
The URL at which to obtain customer support from your MSP.
The contact support behavior of MSP tenant.
The URL at which to open a customer support case with your MSP.
The open case behavior of MSP tenant.
The URL to view your open customer support cases.
The my open case behavior of MSP tenant.
The change password URL of MSP tenant.
Your MSP's customer-support phone number.
Your MSP's customer-support email address.
Your MSP's website.
- RUCKUS One API host for North American region.
https://api.ruckus.cloud/brandings
- RUCKUS One API host for European region.
https://api.eu.ruckus.cloud/brandings
- RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud/brandings
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "msp_label": "msp-label", "logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "alarm_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "ping_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "mlisa_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "ping_login_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "default_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "msp_fqdn": "wifi.sampledomain.com", "contact_support_url": "https://support.sampledomain.com/", "contact_support_behavior": "redirect", "open_case_url": "http://support.sampledomain.com/opencase", "open_case_behavior": "redirect", "my_open_case_url": "http://support.sampledomain.com/myopencase", "my_open_case_behavior": "redirect", "change_password_url": "http://wifi.sampledomain.com/password", "msp_phone": "408-123-5678", "msp_email": "joho.wang@sampledomain.com", "msp_website": "http://wifi.sampledomain.com/", "mspLogoFileDataList": [ { … } ], "preferredWisprProvider": { "id": "string", "createdDate": "2019-08-24T14:15:22Z", "providerName": "string", "apiKey": "string", "apiSecret": "string", "customExternalProvider": true, "auth": { … }, "acct": { … } } }
{ "requestId": "string", "tenantId": "string" }
- application/json
- application/vnd.ruckus.v1+json
The ID of logo file.
The ID of alarm notification logo file.
The ID of ping notification logo file.
The ID of Ruckus Analytics logo file.
The ID of ping login logo file.
The ID of default logo file.
The FQDN of MSP portal.
The URL at which to obtain customer support from your MSP.
The contact support behavior of MSP tenant.
The URL at which to open a customer support case with your MSP.
The open case behavior of MSP tenant.
The URL to view your open customer support cases.
The my open case behavior of MSP tenant.
The change password URL of MSP tenant.
Your MSP's customer-support phone number.
Your MSP's customer-support email address.
Your MSP's website.
- RUCKUS One API host for North American region.
https://api.ruckus.cloud/logoFiles
- RUCKUS One API host for European region.
https://api.eu.ruckus.cloud/logoFiles
- RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud/logoFiles
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "msp_label": "msp-label", "logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "alarm_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "ping_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "mlisa_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "ping_login_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "default_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "msp_fqdn": "wifi.sampledomain.com", "contact_support_url": "https://support.sampledomain.com/", "contact_support_behavior": "redirect", "open_case_url": "http://support.sampledomain.com/opencase", "open_case_behavior": "redirect", "my_open_case_url": "http://support.sampledomain.com/myopencase", "my_open_case_behavior": "redirect", "change_password_url": "http://wifi.sampledomain.com/password", "msp_phone": "408-123-5678", "msp_email": "joho.wang@sampledomain.com", "msp_website": "http://wifi.sampledomain.com/", "mspLogoFileDataList": [ { … } ], "preferredWisprProvider": { "id": "string", "createdDate": "2019-08-24T14:15:22Z", "providerName": "string", "apiKey": "string", "apiSecret": "string", "customExternalProvider": true, "auth": { … }, "acct": { … } } }
{ "requestId": "string", "tenantId": "string" }
- application/json
- application/vnd.ruckus.v1+json
The ID of logo file.
The ID of alarm notification logo file.
The ID of ping notification logo file.
The ID of Ruckus Analytics logo file.
The ID of ping login logo file.
The ID of default logo file.
The FQDN of MSP portal.
The URL at which to obtain customer support from your MSP.
The contact support behavior of MSP tenant.
The URL at which to open a customer support case with your MSP.
The open case behavior of MSP tenant.
The URL to view your open customer support cases.
The my open case behavior of MSP tenant.
The change password URL of MSP tenant.
Your MSP's customer-support phone number.
Your MSP's customer-support email address.
Your MSP's website.
- RUCKUS One API host for North American region.
https://api.ruckus.cloud/logoFiles/{fileId}
- RUCKUS One API host for European region.
https://api.eu.ruckus.cloud/logoFiles/{fileId}
- RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud/logoFiles/{fileId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "msp_label": "msp-label", "logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "alarm_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "ping_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "mlisa_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "ping_login_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "default_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png", "msp_fqdn": "wifi.sampledomain.com", "contact_support_url": "https://support.sampledomain.com/", "contact_support_behavior": "redirect", "open_case_url": "http://support.sampledomain.com/opencase", "open_case_behavior": "redirect", "my_open_case_url": "http://support.sampledomain.com/myopencase", "my_open_case_behavior": "redirect", "change_password_url": "http://wifi.sampledomain.com/password", "msp_phone": "408-123-5678", "msp_email": "joho.wang@sampledomain.com", "msp_website": "http://wifi.sampledomain.com/", "mspLogoFileDataList": [ { … } ], "preferredWisprProvider": { "id": "string", "createdDate": "2019-08-24T14:15:22Z", "providerName": "string", "apiKey": "string", "apiSecret": "string", "customExternalProvider": true, "auth": { … }, "acct": { … } } }
{ "requestId": "string", "tenantId": "string" }