# RUCKUS Edge

# Overview

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

Version: 1.0.4
License: RUCKUS Cloud Privacy Policy

## 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
```

## Download OpenAPI description

[RUCKUS Edge](https://docs.ruckus.cloud/_bundle/api/edge-api-1.0.4.yaml)

## Edge DNS Configuration

Manage the DNS server for a Edge.

### Get DNS Configuration

 - [GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-dns-configuration/getedgednsservers.md): Get the DNS configuration.

### Update DNS Configuration

 - [PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-dns-configuration/patchedgednsservers.md): Patch the DNS configuration.

## Edge Cluster Configuration

Manage the Edge cluster.

### Get Edge Clusters

 - [GET /venues/{venueId}/edgeClusters](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-cluster-configuration/getedgeclustersbypage.md): Get a list of Edge clusters.

### Create Edge Cluster

 - [POST /venues/{venueId}/edgeClusters](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-cluster-configuration/createedgecluster.md): Create a edge cluster.

### Get Edge Cluster

 - [GET /venues/{venueId}/edgeClusters/{clusterId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-cluster-configuration/getedgecluster.md): Get the Edge cluster by unique identifier.

### Delete a Edge Cluster

 - [DELETE /venues/{venueId}/edgeClusters/{clusterId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-cluster-configuration/deletesingleedgecluster.md): Delete a Edge cluster.

### Update Edge Cluster

 - [PATCH /venues/{venueId}/edgeClusters/{clusterId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-cluster-configuration/updateedgecluster.md): Update edge cluster configuration.

### Get Edge Cluster Network

 - [GET /venues/{venueId}/edgeClusters/{clusterId}/networkSettings](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-cluster-configuration/getedgeclusternetworksettings.md): Get Edge cluster network settings.

### Update Edge Cluster Network

 - [PATCH /venues/{venueId}/edgeClusters/{clusterId}/networkSettings](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-cluster-configuration/updateedgeclusternetworksettings.md): Update Edge cluster network settings.

## Edge LAG Configuration

Manage the link aggregation group for Edge devices.

### Get Link Aggregation Group

 - [GET /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-lag-configuration/getedgelinkaggregationgroup.md): Get the link aggregation group by unique identifier.

### Update Link Aggregation Group

 - [PUT /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-lag-configuration/updateedgelinkaggregationgroup.md): Updates the link aggregation group by unique identifier.

### Delete Link Aggregation Group

 - [DELETE /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-lag-configuration/deleteedgelinkaggregationgroup.md): Delete the link aggregation group by unique identifier.

### Partial Update Link Aggregation Group

 - [PATCH /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-lag-configuration/partialupdateedgelinkaggregationgroup.md): Partial update of the link aggregation group by unique identifier.

### Create Link Aggregation Group

 - [POST /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-lag-configuration/createedgelinkaggregationgroup.md): Create the link aggregation groups.

## Edge LAG Subinterface

Manage the subinterface of a LAG.

### Create Subinterface

 - [POST /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-lag-subinterface/createedgelagsubinterface.md): Create a subinterfaces of a LAG.

### Get Subinterface

 - [GET /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-lag-subinterface/getedgelagsubinterface.md): Get the subinterface of a LAG.

### Delete Subinterface

 - [DELETE /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-lag-subinterface/deleteedgelagsubinterface.md): Delete a subinterfaces of a LAG.

### Partial Update Subinterface

 - [PATCH /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-lag-subinterface/patchedgelagsubinterface.md): Partial update a subinterface of a LAG.

## Tunnel Profile Configuration

Manage the tunnel profile.

### Activate Tunnel on Edge Cluster

 - [PUT /venues/{venueId}/edgeClusters/{clusterId}/tunnelProfiles/{tunnelProfileId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/tunnel-profile-configuration/edgeclusteractivatetunnelprofile.md): Activate tunnel profile on edge cluster.

### Deactivate Tunnel on Edge Cluster

 - [DELETE /venues/{venueId}/edgeClusters/{clusterId}/tunnelProfiles/{tunnelProfileId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/tunnel-profile-configuration/edgeclusterdeactivatetunnelprofile.md): Deactivate tunnel profile on edge cluster.

## Edge Subinterface Configuration

Manage the subinterface of a physical port.

### Get Subinterfaces

 - [GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-subinterface-configuration/getedgesubinterfaces.md): Get subinterfaces of a physical port.

### Create Subinterface

 - [POST /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-subinterface-configuration/createedgesubinterface.md): Create a subinterfaces of a physical port.

### Delete Subinterface

 - [DELETE /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-subinterface-configuration/deleteedgesubinterface.md): Delete a subinterfaces of a physical port.

### Update Subinterface

 - [PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-subinterface-configuration/patchedgesubinterface.md): Update a subinterface of a physical port.

## Edge Static Route Configuration

Manage the static routes for a Edge.

### Get Static Route Configuration

 - [GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-static-route-configuration/getedgestaticrouteconfig.md): Get static routes configuration.

### Update Static Route Configuration

 - [PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-static-route-configuration/patchedgestaticrouteconfig.md): Patch static route configuration.

## Edge Multicast DNS Profile

Manage the Multicast DNS Profile for Edge devices.

### Get Multicast DNS Profile

 - [GET /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-multicast-dns-profile/getmdnsproxyprofile.md): Get multicast DNS profile.

### Update Multicast DNS Profile

 - [PUT /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-multicast-dns-profile/updatemdnsproxyprofile.md): Update multicast DNS profile.

### Delete Multicast DNS Profile

 - [DELETE /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-multicast-dns-profile/deletemdnsproxyprofile.md): Delete multicast DNS profile.

### Activate Multicast DNS

 - [PUT /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}/venues/{venueId}/edgeClusters/{edgeClusterId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-multicast-dns-profile/activatemdnsproxy.md): Activate multicast DNS on edge cluster.

### Deactivate Multicast DNS

 - [DELETE /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}/venues/{venueId}/edgeClusters/{edgeClusterId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-multicast-dns-profile/deactivatemdnsproxy.md): Deactivate multicast DNS on edge cluster.

### Create Multicast DNS Profile

 - [POST /edgeMulticastDnsProxyProfiles](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-multicast-dns-profile/createmdnsproxyprofile.md): Create multicast DNS profile.

## Edge Troubleshooting

Manage troubleshooting operations for the devices.

### Trigger Edge Action

 - [PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/hostDetails](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-troubleshooting/triggeredgeaction.md): Allows for the edge troubleshooting actions.

## Edge DHCP

Manage the DHCP services for Edge devices.

### Get DHCP

 - [GET /edgeDhcpServices/{dhcpId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-dhcp/getdhcpbyid.md): Get DHCP configuration for edge cluster.

### Update DHCP

 - [PUT /edgeDhcpServices/{dhcpId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-dhcp/updatedhcp.md): Update DHCP configuration for edge cluster.

### Delete DHCP

 - [DELETE /edgeDhcpServices/{dhcpId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-dhcp/deletedhcpbyid.md): Delete DHCP configuration for edge cluster.

### Patch DHCP

 - [PATCH /edgeDhcpServices/{dhcpId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-dhcp/patchdhcp.md): Partial update DHCP configuration for edge cluster.

### Activate DHCP

 - [PUT /edgeDhcpServices/{dhcpId}/venues/{venueId}/edgeClusters/{edgeClusterId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-dhcp/activatedhcp.md): Activate DHCP service on Edge Cluster.

### Deactivate DHCP

 - [DELETE /edgeDhcpServices/{dhcpId}/venues/{venueId}/edgeClusters/{edgeClusterId}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-dhcp/deactivatedhcp.md): Deactivate DHCP service on edge cluster.

### Create DHCP

 - [POST /edgeDhcpServices](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-dhcp/createdhcp.md): Create DHCP configuration for edge cluster.

### Query DHCP Edge Compatibility Details

 - [POST /edgeDhcpServices/edgeCompatibilities/query](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-dhcp/queryedgedhcpservicecompatibilities.md): Query the compatibility info of Edge by DHCP services.

## Edge Port Configuration

Manage the port of a Edge.

### Get Physical Port Configuration

 - [GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-port-configuration/getedgeportconfig.md): Get the physical port configuration.

### Update Physical Port Configuration

 - [PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-port-configuration/patchedgeportconfig.md): Patch the physical port configuration.

## ARP Termination Settings

Configure ARP termination settings for a cluster.

### Get ARP Termination Settings

 - [GET /venues/{venueId}/edgeClusters/{clusterId}/arpTerminationSettings](https://docs.ruckus.cloud/api/edge-api-1.0.4/arp-termination-settings/getarpterminationsettings.md): Get ARP termination settings.

### Update ARP Termination Settings

 - [PUT /venues/{venueId}/edgeClusters/{clusterId}/arpTerminationSettings](https://docs.ruckus.cloud/api/edge-api-1.0.4/arp-termination-settings/updatearpterminationsettings.md): Update ARP termination settings.

## Edge Compatibility Checking

Check the compatibility of Edge devices.

### Query Venue Edge Compatibility Information

 - [POST /venues/edgeCompatibilities/query](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-compatibility-checking/queryvenueedgecompatibilities.md): Query the compatibility info of Edge by venues or devices.

### Query Edge Features Requirement Information

 - [POST /edgeFeatureSets/query](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-compatibility-checking/queryedgefeaturesrequirement.md): Query features' requirement info related to Edge.

## Edge Device Management

Edge device management operations.

### Add Device

 - [POST /venues/{venueId}/edgeClusters/{clusterId}/edges](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-device-management/createedgedevice.md): Add a new device.

### Get Device

 - [GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-device-management/getedgedevice.md): Get device by the serial number.

### Delete Device

 - [DELETE /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-device-management/deleteedgedevice.md): Delete the device by the serial number.

### Update Device

 - [PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}](https://docs.ruckus.cloud/api/edge-api-1.0.4/edge-device-management/patchedgedevice.md): Patch the device configuration.