Manage the DNS server for a Edge.
RUCKUS Edge (1.0.4)
The Edge REST API provides comprehensive capabilities for managing edge devices, edge clusters, and network services in the RUCKUS Cloud platform. This API enables you to configure edge device settings, manage cluster configurations with high availability, control network services.
The API is designed for organizations that need to manage edge devices, configure cluster settings, control network services such as DHCP, establish tunnel profiles, and manage advanced networking features for distributed edge deployments.
What This API Does
- Edge Device Management: Create, retrieve, update, and delete edge devices with configuration settings including device registration and basic metadata management
- Edge Cluster Configuration: Manage edge cluster settings including high availability configurations and network settings
- Network Interface Configuration: Configure edge ports, link aggregation groups (LAG), subinterfaces, static routes, and DNS servers for edge devices
- DHCP Services: Manage the DHCP services for edge clusters
- Tunnel Profile Configuration: Activate and deactivate tunnel profiles on edge clusters
- mDNS Proxy: Configure mDNS proxy profiles for edge clusters
- ARP Termination: Configure ARP termination settings for edge clusters
- Edge Compatibility: Query edge device feature requirements and compatibility information
- Troubleshooting: Trigger edge troubleshooting actions
Download OpenAPI description
Overview
License
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud
- RUCKUS One API host for North American region.https://api.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
{ "id": "string", "name": "string", "forwardingRules": [ { … } ] }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "name": "string", "forwardingRules": [ { … } ] }
Response
{ "requestId": "string", "response": null, "links": [ { … } ] }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
{ "requestId": "string", "response": null, "links": [ { … } ] }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}/venues/{venueId}/edgeClusters/{edgeClusterId}
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}/venues/{venueId}/edgeClusters/{edgeClusterId}
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}/venues/{venueId}/edgeClusters/{edgeClusterId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
{ "requestId": "string", "response": null, "links": [ { … } ] }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}/venues/{venueId}/edgeClusters/{edgeClusterId}
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}/venues/{venueId}/edgeClusters/{edgeClusterId}
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}/venues/{venueId}/edgeClusters/{edgeClusterId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
{ "requestId": "string", "response": null, "links": [ { … } ] }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/edgeMulticastDnsProxyProfiles
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/edgeMulticastDnsProxyProfiles
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/edgeMulticastDnsProxyProfiles
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "name": "string", "forwardingRules": [ { … } ] }
Response
{ "requestId": "string", "response": null, "links": [ { … } ] }