Skip to content
Overview/
/RUCKUS Edge/
Changed
Last updated

RUCKUS Edge

PUT /edgeDhcpServices/{dhcpId}/venues/{venueId}/edgeClusters/{edgeClusterId}
Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Added property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Added property requestId (object)

      A unique identifier for the specific API request.

    • Added property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Added property requestId (object)

      A unique identifier for the specific API request.

    • Added property response (object)

      The response body containing the actual result data.

  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

DELETE /edgeDhcpServices/{dhcpId}/venues/{venueId}/edgeClusters/{edgeClusterId}
Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Added property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Added property requestId (object)

      A unique identifier for the specific API request.

    • Added property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Added property requestId (object)

      A unique identifier for the specific API request.

    • Added property response (object)

      The response body containing the actual result data.

  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

PUT /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}/venues/{venueId}/edgeClusters/{edgeClusterId}
Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Added property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Added property requestId (object)

      A unique identifier for the specific API request.

    • Added property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Added property requestId (object)

      A unique identifier for the specific API request.

    • Added property response (object)

      The response body containing the actual result data.

  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

DELETE /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}/venues/{venueId}/edgeClusters/{edgeClusterId}
Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Added property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Added property requestId (object)

      A unique identifier for the specific API request.

    • Added property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Added property requestId (object)

      A unique identifier for the specific API request.

    • Added property response (object)

      The response body containing the actual result data.

  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

POST /edgeDhcpServices
Request:
  • Changed content type : application/json

New optional properties:

  • leaseTime
  • leaseTimeUnit
  • serviceName

  • Changed property dhcpOptions (object)

    List of DHCP options.

  • Changed property dhcpPools (object)

    List of DHCP pools.

  • Changed property dhcpRelay (object)

    Whether DHCP relay is enabled.

  • Changed property domainName (object)

    The domain name for DHCP clients.

  • Changed property externalDhcpServerFqdnIp (object)

    The external DHCP server FQDN or IP address.

  • Changed property hosts (object)

    List of DHCP hosts with fixed IP addresses.

  • Changed property id (object)

    The identifier of the Edge DHCP profile.

  • Changed property leaseTime (object)

    The lease time duration.

  • Changed property leaseTimeUnit (object)

    The unit of the lease time.

  • Changed property primaryDnsIp (object)

    The primary DNS server IP address.

  • Changed property secondaryDnsIp (object)

    The secondary DNS server IP address.

  • Changed property serviceName (object)

    The name of the DHCP service.

  • Changed content type : application/vnd.ruckus.v1+json

New optional properties:

  • leaseTime
  • leaseTimeUnit
  • serviceName

  • Changed property dhcpOptions (object)

    List of DHCP options.

  • Changed property dhcpPools (object)

    List of DHCP pools.

  • Changed property dhcpRelay (object)

    Whether DHCP relay is enabled.

  • Changed property domainName (object)

    The domain name for DHCP clients.

  • Changed property externalDhcpServerFqdnIp (object)

    The external DHCP server FQDN or IP address.

  • Changed property hosts (object)

    List of DHCP hosts with fixed IP addresses.

  • Changed property id (object)

    The identifier of the Edge DHCP profile.

  • Changed property leaseTime (object)

    The lease time duration.

  • Changed property leaseTimeUnit (object)

    The unit of the lease time.

  • Changed property primaryDnsIp (object)

    The primary DNS server IP address.

  • Changed property secondaryDnsIp (object)

    The secondary DNS server IP address.

  • Changed property serviceName (object)

    The name of the DHCP service.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

DELETE /edgeDhcpServices/{dhcpId}
Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Added property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Added property requestId (object)

      A unique identifier for the specific API request.

    • Added property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Added property requestId (object)

      A unique identifier for the specific API request.

    • Added property response (object)

      The response body containing the actual result data.

  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

GET /edgeDhcpServices/{dhcpId}
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    New optional properties:

    • leaseTime
    • leaseTimeUnit
    • serviceName

    • Changed property dhcpOptions (object)

      List of DHCP options.

    • Changed property dhcpPools (object)

      List of DHCP pools.

    • Changed property dhcpRelay (object)

      Whether DHCP relay is enabled.

    • Changed property domainName (object)

      The domain name for DHCP clients.

    • Changed property externalDhcpServerFqdnIp (object)

      The external DHCP server FQDN or IP address.

    • Changed property hosts (object)

      List of DHCP hosts with fixed IP addresses.

    • Changed property id (object)

      The identifier of the Edge DHCP profile.

    • Changed property leaseTime (object)

      The lease time duration.

    • Changed property leaseTimeUnit (object)

      The unit of the lease time.

    • Changed property primaryDnsIp (object)

      The primary DNS server IP address.

    • Changed property secondaryDnsIp (object)

      The secondary DNS server IP address.

    • Changed property serviceName (object)

      The name of the DHCP service.

  • Changed content type : application/vnd.ruckus.v1+json

    New optional properties:

    • leaseTime
    • leaseTimeUnit
    • serviceName

    • Changed property dhcpOptions (object)

      List of DHCP options.

    • Changed property dhcpPools (object)

      List of DHCP pools.

    • Changed property dhcpRelay (object)

      Whether DHCP relay is enabled.

    • Changed property domainName (object)

      The domain name for DHCP clients.

    • Changed property externalDhcpServerFqdnIp (object)

      The external DHCP server FQDN or IP address.

    • Changed property hosts (object)

      List of DHCP hosts with fixed IP addresses.

    • Changed property id (object)

      The identifier of the Edge DHCP profile.

    • Changed property leaseTime (object)

      The lease time duration.

    • Changed property leaseTimeUnit (object)

      The unit of the lease time.

    • Changed property primaryDnsIp (object)

      The primary DNS server IP address.

    • Changed property secondaryDnsIp (object)

      The secondary DNS server IP address.

    • Changed property serviceName (object)

      The name of the DHCP service.

PUT /edgeDhcpServices/{dhcpId}
Request:
  • Changed content type : application/json

New optional properties:

  • leaseTime
  • leaseTimeUnit
  • serviceName

  • Changed property action (object)

    The action to perform on the DHCP service.

  • Changed property dhcpOptions (object)

    List of DHCP options.

  • Changed property dhcpPools (object)

    List of DHCP pools.

  • Changed property dhcpRelay (object)

    Whether DHCP relay is enabled.

  • Changed property domainName (object)

    The domain name for DHCP clients.

  • Changed property externalDhcpServerFqdnIp (object)

    The external DHCP server FQDN or IP address.

  • Changed property hosts (object)

    List of DHCP hosts with fixed IP addresses.

  • Changed property leaseTime (object)

    The lease time duration.

  • Changed property leaseTimeUnit (object)

    The unit of the lease time.

  • Changed property primaryDnsIp (object)

    The primary DNS server IP address.

  • Changed property secondaryDnsIp (object)

    The secondary DNS server IP address.

  • Changed property serviceName (object)

    The name of the DHCP service.

  • Changed content type : application/vnd.ruckus.v1+json

New optional properties:

  • leaseTime
  • leaseTimeUnit
  • serviceName

  • Changed property action (object)

    The action to perform on the DHCP service.

  • Changed property dhcpOptions (object)

    List of DHCP options.

  • Changed property dhcpPools (object)

    List of DHCP pools.

  • Changed property dhcpRelay (object)

    Whether DHCP relay is enabled.

  • Changed property domainName (object)

    The domain name for DHCP clients.

  • Changed property externalDhcpServerFqdnIp (object)

    The external DHCP server FQDN or IP address.

  • Changed property hosts (object)

    List of DHCP hosts with fixed IP addresses.

  • Changed property leaseTime (object)

    The lease time duration.

  • Changed property leaseTimeUnit (object)

    The unit of the lease time.

  • Changed property primaryDnsIp (object)

    The primary DNS server IP address.

  • Changed property secondaryDnsIp (object)

    The secondary DNS server IP address.

  • Changed property serviceName (object)

    The name of the DHCP service.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

PATCH /edgeDhcpServices/{dhcpId}
Request:
  • Changed content type : application/json

  • Changed property action (object)

    The action to perform on the DHCP service.

  • Changed property dhcpOptions (object)

    List of DHCP options.

  • Changed property dhcpPools (object)

    List of DHCP pools.

  • Changed property dhcpRelay (object)

    Whether DHCP relay is enabled.

  • Changed property domainName (object)

    The domain name for DHCP clients.

  • Changed property externalDhcpServerFqdnIp (object)

    The external DHCP server FQDN or IP address.

  • Changed property hosts (object)

    List of DHCP hosts with fixed IP addresses.

  • Changed property leaseTime (object)

    The lease time duration.

  • Changed property leaseTimeUnit (object)

    The unit of the lease time.

  • Changed property primaryDnsIp (object)

    The primary DNS server IP address.

  • Changed property secondaryDnsIp (object)

    The secondary DNS server IP address.

  • Changed property serviceName (object)

    The name of the DHCP service.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property action (object)

    The action to perform on the DHCP service.

  • Changed property dhcpOptions (object)

    List of DHCP options.

  • Changed property dhcpPools (object)

    List of DHCP pools.

  • Changed property dhcpRelay (object)

    Whether DHCP relay is enabled.

  • Changed property domainName (object)

    The domain name for DHCP clients.

  • Changed property externalDhcpServerFqdnIp (object)

    The external DHCP server FQDN or IP address.

  • Changed property hosts (object)

    List of DHCP hosts with fixed IP addresses.

  • Changed property leaseTime (object)

    The lease time duration.

  • Changed property leaseTimeUnit (object)

    The unit of the lease time.

  • Changed property primaryDnsIp (object)

    The primary DNS server IP address.

  • Changed property secondaryDnsIp (object)

    The secondary DNS server IP address.

  • Changed property serviceName (object)

    The name of the DHCP service.

Return Type:
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Added property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Added property requestId (object)

      A unique identifier for the specific API request.

    • Added property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Added property requestId (object)

      A unique identifier for the specific API request.

    • Added property response (object)

      The response body containing the actual result data.

  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

POST /edgeMulticastDnsProxyProfiles
Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

GET /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

PUT /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}
Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

DELETE /edgeMulticastDnsProxyProfiles/{multicastDnsProxyProfileId}
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

GET /venues/{venueId}/edgeClusters/{clusterId}/arpTerminationSettings
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

PUT /venues/{venueId}/edgeClusters/{clusterId}/arpTerminationSettings
Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

POST /venues/{venueId}/edgeClusters/{clusterId}/edges
Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 201 Created

Created

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    New optional properties:

    • name
    • Changed property name (object)

      The name of the device.

  • Changed content type : application/vnd.ruckus.v1+json

    New optional properties:

    • name
    • Changed property name (object)

      The name of the device.

DELETE /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}
Request:
  • Changed content type : application/json

New optional properties:

  • name
  • Changed property otpState (object)

    The OTP state for the Edge device.

  • Changed content type : application/vnd.ruckus.v1+json

New optional properties:

  • name
  • Changed property otpState (object)

    The OTP state for the Edge device.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property primary (object)

      The primary DNS server IP address.

    • Changed property secondary (object)

      The secondary DNS server IP address.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property primary (object)

      The primary DNS server IP address.

    • Changed property secondary (object)

      The secondary DNS server IP address.

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/dnsServers
Request:
  • Changed content type : application/json

  • Changed property primary (object)

    The primary DNS server IP address.

  • Changed property secondary (object)

    The secondary DNS server IP address.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property primary (object)

    The primary DNS server IP address.

  • Changed property secondary (object)

    The secondary DNS server IP address.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/hostDetails
Request:
  • Changed content type : application/json

  • Changed property action (object)

    The action to perform on the Edge device.

  • Changed property targetHost (object)

    The target host IP address or domain name for the troubleshooting action.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json
  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json
  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json
  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json
  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json
  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property ports (object)

      List of physical port configurations.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property ports (object)

      List of physical port configurations.

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs
Request:
  • Changed content type : application/json
  • Changed property ports (object)

    List of physical port configurations.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property ports (object)

    List of physical port configurations.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces

Get Subinterfaces

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • New content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property content (object)

      List of subinterface configuration data.

    • Changed property page (object)

      Zero based page index.

POST /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces

Create Subinterface

Request:

New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

New optional properties:

  • portType

  • Changed property ipMode (object)

    The IP mode for the subinterface.

  • Changed property portType (object)

    The port type of the subinterface.

  • Changed property subnet (object)

    The IP subnet mask to be assigned to the port.

  • Changed property vlan (object)

    The virtual LAN ID of the subinterface.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • New content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

DELETE /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}

Delete Subinterface

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • New content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}

Update Subinterface

Request:

New content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

New optional properties:

  • portType

  • Changed property ipMode (object)

    The IP mode for the subinterface.

  • Changed property portType (object)

    The port type of the subinterface.

  • Changed property subnet (object)

    The IP subnet mask to be assigned to the port.

  • Changed property vlan (object)

    The virtual LAN ID of the subinterface.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • New content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property routes (object)

      List of static route configurations.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property routes (object)

      List of static route configurations.

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/staticRouteConfigs
Request:
  • Changed content type : application/json
  • Changed property routes (object)

    List of static route configurations.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property routes (object)

    List of static route configurations.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

PUT /venues/{venueId}/edgeClusters/{clusterId}/tunnelProfiles/{tunnelProfileId}

Activate Tunnel on Edge Cluster

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

DELETE /venues/{venueId}/edgeClusters/{clusterId}/tunnelProfiles/{tunnelProfileId}

Deactivate Tunnel on Edge Cluster

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

POST /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags
Request:
  • Changed content type : application/json

  • Changed property ipMode (object)

    The ip mode of the LAG.

  • Changed property lacpMode (object)

    LACP operation mode (ACTIVE or PASSIVE) for link aggregation.

  • Changed property lacpTimeout (object)

    LACP timeout interval (SHORT or LONG) for link failure detection.

  • Changed property lagMembers (object)

    List of port members in the LAG.

  • Changed property portType (object)

    The port type of the LAG.

  • Changed property subnet (object)

    The IP subnet mask to be assigned to the port.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property ipMode (object)

    The ip mode of the LAG.

  • Changed property lacpMode (object)

    LACP operation mode (ACTIVE or PASSIVE) for link aggregation.

  • Changed property lacpTimeout (object)

    LACP timeout interval (SHORT or LONG) for link failure detection.

  • Changed property lagMembers (object)

    List of port members in the LAG.

  • Changed property portType (object)

    The port type of the LAG.

  • Changed property subnet (object)

    The IP subnet mask to be assigned to the port.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

GET /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property ipMode (object)

      The ip mode of the LAG.

    • Changed property lacpMode (object)

      LACP operation mode (ACTIVE or PASSIVE) for link aggregation.

    • Changed property lacpTimeout (object)

      LACP timeout interval (SHORT or LONG) for link failure detection.

    • Changed property lagMembers (object)

      List of port members in the LAG.

    • Changed property portType (object)

      The port type of the LAG.

    • Changed property reportSubnet (object)

      Subnet mask reported by edge device.

    • Changed property subnet (object)

      The IP subnet mask to be assigned to the port.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property ipMode (object)

      The ip mode of the LAG.

    • Changed property lacpMode (object)

      LACP operation mode (ACTIVE or PASSIVE) for link aggregation.

    • Changed property lacpTimeout (object)

      LACP timeout interval (SHORT or LONG) for link failure detection.

    • Changed property lagMembers (object)

      List of port members in the LAG.

    • Changed property portType (object)

      The port type of the LAG.

    • Changed property reportSubnet (object)

      Subnet mask reported by edge device.

    • Changed property subnet (object)

      The IP subnet mask to be assigned to the port.

PUT /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}
Request:
  • Changed content type : application/json

  • Changed property ipMode (object)

    The ip mode of the LAG.

  • Changed property lacpMode (object)

    LACP operation mode (ACTIVE or PASSIVE) for link aggregation.

  • Changed property lacpTimeout (object)

    LACP timeout interval (SHORT or LONG) for link failure detection.

  • Changed property lagMembers (object)

    List of port members in the LAG.

  • Changed property portType (object)

    The port type of the LAG.

  • Changed property subnet (object)

    The IP subnet mask to be assigned to the port.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property ipMode (object)

    The ip mode of the LAG.

  • Changed property lacpMode (object)

    LACP operation mode (ACTIVE or PASSIVE) for link aggregation.

  • Changed property lacpTimeout (object)

    LACP timeout interval (SHORT or LONG) for link failure detection.

  • Changed property lagMembers (object)

    List of port members in the LAG.

  • Changed property portType (object)

    The port type of the LAG.

  • Changed property subnet (object)

    The IP subnet mask to be assigned to the port.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

DELETE /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

PATCH /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}
Request:
  • Changed content type : application/json

  • Changed property ipMode (object)

    The ip mode of the LAG.

  • Changed property lacpMode (object)

    LACP operation mode (ACTIVE or PASSIVE) for link aggregation.

  • Changed property lacpTimeout (object)

    LACP timeout interval (SHORT or LONG) for link failure detection.

  • Changed property lagMembers (object)

    List of port members in the LAG.

  • Changed property portType (object)

    The port type of the LAG.

  • Changed property subnet (object)

    The IP subnet mask to be assigned to the port.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property ipMode (object)

    The ip mode of the LAG.

  • Changed property lacpMode (object)

    LACP operation mode (ACTIVE or PASSIVE) for link aggregation.

  • Changed property lacpTimeout (object)

    LACP timeout interval (SHORT or LONG) for link failure detection.

  • Changed property lagMembers (object)

    List of port members in the LAG.

  • Changed property portType (object)

    The port type of the LAG.

  • Changed property subnet (object)

    The IP subnet mask to be assigned to the port.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

POST /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces

Create Subinterface

Parameters:
  • Changed: lagId in path

ID of the LAG

Request:
  • Changed content type : application/json

  • Changed property ipMode (object)

    The IP mode for the subinterface.

  • Changed property portType (object)

    The port type of the subinterface.

  • Changed property subnet (object)

    The IP subnet mask to be assigned to the port.

  • Changed property vlan (object)

    The virtual LAN ID of the subinterface.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property ipMode (object)

    The IP mode for the subinterface.

  • Changed property portType (object)

    The port type of the subinterface.

  • Changed property subnet (object)

    The IP subnet mask to be assigned to the port.

  • Changed property vlan (object)

    The virtual LAN ID of the subinterface.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

GET /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

Get Subinterface

Parameters:
  • Changed: lagId in path

ID of the LAG

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property ipMode (object)

      The IP mode for the subinterface.

    • Changed property portType (object)

      The port type of the subinterface.

    • Changed property subnet (object)

      The IP subnet mask to be assigned to the port.

    • Changed property vlan (object)

      The virtual LAN ID of the subinterface.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property ipMode (object)

      The IP mode for the subinterface.

    • Changed property portType (object)

      The port type of the subinterface.

    • Changed property subnet (object)

      The IP subnet mask to be assigned to the port.

    • Changed property vlan (object)

      The virtual LAN ID of the subinterface.

DELETE /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

Delete Subinterface

Parameters:
  • Changed: lagId in path

ID of the LAG

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

PATCH /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}

Partial Update Subinterface

Parameters:
  • Changed: lagId in path

ID of the LAG

Request:
  • Changed content type : application/json

  • Changed property ipMode (object)

    The IP mode for the subinterface.

  • Changed property portType (object)

    The port type of the subinterface.

  • Changed property subnet (object)

    The IP subnet mask to be assigned to the port.

  • Changed property vlan (object)

    The virtual LAN ID of the subinterface.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property ipMode (object)

    The IP mode for the subinterface.

  • Changed property portType (object)

    The port type of the subinterface.

  • Changed property subnet (object)

    The IP subnet mask to be assigned to the port.

  • Changed property vlan (object)

    The virtual LAN ID of the subinterface.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

POST /edgeDhcpServices/edgeCompatibilities/query

Query DHCP Edge Compatibility Details

Request:
  • Changed content type : application/json

  • Changed property filters (object)

    Filters for querying Edge compatibility by service.

    • Changed property serviceIds (object)

      List of service identifiers to filter by.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    Filters for querying Edge compatibility by service.

    • Changed property serviceIds (object)

      List of service identifiers to filter by.

  • Changed content type : application/vnd.ruckus.v1.1+json

  • Changed property filters (object)

    Filters for querying Edge compatibility by service.

    • Changed property serviceIds (object)

      List of service identifiers to filter by.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property compatibilities (object)

      List of compatibility information for services and Edge devices.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property compatibilities (object)

      List of compatibility information for services and Edge devices.

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Changed property compatibilities (object)

      List of compatibility information for services and Edge devices.

POST /edgeFeatureSets/query

Query Edge Features Requirement Information

Request:
  • Changed content type : application/json

  • Changed property filters (object)

    Filters for querying edge feature sets.

    • Changed property featureNames (object)

      List of feature names to filter by.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    Filters for querying edge feature sets.

    • Changed property featureNames (object)

      List of feature names to filter by.

  • Changed content type : application/vnd.ruckus.v1.1+json

  • Changed property filters (object)

    Filters for querying edge feature sets.

    • Changed property featureNames (object)

      List of feature names to filter by.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed content type : application/vnd.ruckus.v1.1+json

POST /venues/edgeCompatibilities/query

Query Venue Edge Compatibility Information

Request:
  • Changed content type : application/json

  • Changed property filters (object)

    Filters for querying Edge compatibility by venue.

    • Changed property edgeIds (object)

      List of Edge device identifiers to filter by.

    • Changed property venueIds (object)

      List of venue identifiers to filter by.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    Filters for querying Edge compatibility by venue.

    • Changed property edgeIds (object)

      List of Edge device identifiers to filter by.

    • Changed property venueIds (object)

      List of venue identifiers to filter by.

  • Changed content type : application/vnd.ruckus.v1.1+json

  • Changed property filters (object)

    Filters for querying Edge compatibility by venue.

    • Changed property edgeIds (object)

      List of Edge device identifiers to filter by.

    • Changed property venueIds (object)

      List of venue identifiers to filter by.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property compatibilities (object)

      List of compatibility information for venues and Edge devices.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property compatibilities (object)

      List of compatibility information for venues and Edge devices.

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Changed property compatibilities (object)

      List of compatibility information for venues and Edge devices.

POST /venues/{venueId}/edgeClusters
Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1.1+json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

GET /venues/{venueId}/edgeClusters
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property content (object)

      The content of the current page.

    • Changed property paging (object)

      Paging information.

      • Changed property page (object)

        The current page number.

      • Changed property pageSize (object)

        The number of items per page.

      • Changed property totalCount (object)

        The total number of items across all pages.

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Changed property content (object)

      The content of the current page.

    • Changed property paging (object)

      Paging information.

      • Changed property page (object)

        The current page number.

      • Changed property pageSize (object)

        The number of items per page.

      • Changed property totalCount (object)

        The total number of items across all pages.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property content (object)

      The content of the current page.

    • Changed property paging (object)

      Paging information.

      • Changed property page (object)

        The current page number.

      • Changed property pageSize (object)

        The number of items per page.

      • Changed property totalCount (object)

        The total number of items across all pages.

DELETE /venues/{venueId}/edgeClusters/{clusterId}
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

GET /venues/{venueId}/edgeClusters/{clusterId}
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property virtualIpSettings (object)

      The virtual IP settings of the cluster.

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Changed property virtualIpSettings (object)

      The virtual IP settings of the cluster.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property virtualIpSettings (object)

      The virtual IP settings of the cluster.

PATCH /venues/{venueId}/edgeClusters/{clusterId}
Request:
  • Changed content type : application/json
  • Changed property virtualIpSettings (object)

    The virtual IP settings of the cluster.

  • Changed content type : application/vnd.ruckus.v1.1+json
  • Changed property virtualIpSettings (object)

    The virtual IP settings of the cluster.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property virtualIpSettings (object)

    The virtual IP settings of the cluster.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • New content type : application/vnd.ruckus.v1.1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

GET /venues/{venueId}/edgeClusters/{clusterId}/networkSettings
Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property subInterfaceSettings (object)

      List of cluster subinterface settings.

    • Changed property multiWanSettings (object)

      The multi WAN settings of the Edge cluster.

      • Changed property mode (object)

        Defines the dual WAN mode for the edge.

    • Changed property highAvailabilitySettings (object)

      High availability settings for active-active clusters.

      • Changed property fallbackSettings (object)

        Settings for client to attempt reconnecting to the primary node.

        • Changed property schedule (object)

          Schedule for clients to attempt reconnecting to the primary node.

          • Changed property intervalHours (object)

            Reconnection interval specified in hours.

          • Changed property type (object)

            The type of scheduling.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property subInterfaceSettings (object)

      List of cluster subinterface settings.

    • Changed property multiWanSettings (object)

      The multi WAN settings of the Edge cluster.

      • Changed property mode (object)

        Defines the dual WAN mode for the edge.

    • Changed property highAvailabilitySettings (object)

      High availability settings for active-active clusters.

      • Changed property fallbackSettings (object)

        Settings for client to attempt reconnecting to the primary node.

        • Changed property schedule (object)

          Schedule for clients to attempt reconnecting to the primary node.

          • Changed property intervalHours (object)

            Reconnection interval specified in hours.

          • Changed property type (object)

            The type of scheduling.

PATCH /venues/{venueId}/edgeClusters/{clusterId}/networkSettings
Request:
  • Changed content type : application/json

  • Changed property lagSettings (object)

    List of cluster edges LAG settings.

  • Changed property portSettings (object)

    List of cluster edges port settings.

  • Changed property subInterfaceSettings (object)

    List of cluster subinterface settings.

  • Changed property multiWanSettings (object)

    The multi WAN settings of the Edge cluster.

    • Changed property mode (object)

      Defines the dual WAN mode for the edge.

  • Changed property highAvailabilitySettings (object)

    High availability settings for active-active clusters.

    • Changed property fallbackSettings (object)

      Settings for client to attempt reconnecting to the primary node.

      • Changed property schedule (object)

        Schedule for clients to attempt reconnecting to the primary node.

        • Changed property intervalHours (object)

          Reconnection interval specified in hours.

        • Changed property type (object)

          The type of scheduling.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property lagSettings (object)

    List of cluster edges LAG settings.

  • Changed property portSettings (object)

    List of cluster edges port settings.

  • Changed property subInterfaceSettings (object)

    List of cluster subinterface settings.

  • Changed property multiWanSettings (object)

    The multi WAN settings of the Edge cluster.

    • Changed property mode (object)

      Defines the dual WAN mode for the edge.

  • Changed property highAvailabilitySettings (object)

    High availability settings for active-active clusters.

    • Changed property fallbackSettings (object)

      Settings for client to attempt reconnecting to the primary node.

      • Changed property schedule (object)

        Schedule for clients to attempt reconnecting to the primary node.

        • Changed property intervalHours (object)

          Reconnection interval specified in hours.

        • Changed property type (object)

          The type of scheduling.

Return Type:
  • Changed response : 400 Bad Request

Bad/malformed request

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 401 Unauthorized

Unauthorized

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 403 Forbidden

Forbidden

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Requested resource or related entity not found

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 422 Unprocessable Entity

Validation error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 500 Internal Server Error

Internal Server Error

  • New content type : application/json

  • New content type : application/vnd.ruckus.v1+json

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property links (object)

      A collection of related resource links (HATEOAS) allowing clients to discover related resources.

    • Changed property requestId (object)

      A unique identifier for the specific API request.

    • Changed property response (object)

      The response body containing the actual result data.

Previous page
Next page