Refresh Switches

Pending Assets Management (0.0.1)

API for device provisioning and management in Ruckus Cloud platform. This service provides endpoints for managing device refresh jobs, status reports, and hidden device configurations for Access Points and Switches.

Ruckus Network Technical Documents

Download OpenAPI description

Download PDF

Overview

License

RUCKUS Cloud Privacy Policy

Servers

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud

RUCKUS One API host for North American region.

https://api.ruckus.cloud

Pending Assets Management

Device provisioning and management APIs for Access Points and Switches.

Operations

Update Switch Status

Request

Updates the operational status of switches.

Body

required

serialsArray of stringsrequired

List of device serial numbers to perform the action on.

Example: ["461802000001","461802000002","461802000001"]

statusstringrequired

Management action to perform on the specified devices.

Value"hide"

Example: "hide"

{
  "serials": [
    "461802000001",
    "461802000002",
    "461802000001"
  ],
  "status": "hide"
}

Responses

Switch status updated successfully

Body

messagestring

A message describing the result of the operation.

Example: "Switches added to hidden devices successfully."

requestIdstring

Unique identifier for tracking the request.

Example: "902af641-b8c3-4b9f-bd71-2c3fe8adf745"

statusstring

Status of the management operation execution.

Value"hide"

Example: "hide"

serialsArray of strings

List of device serial numbers that were processed in this operation.

Example: ["461802000001","461802000002","461802000003"]

Response

{
  "message": "Switches added to hidden devices successfully.",
  "requestId": "902af641-b8c3-4b9f-bd71-2c3fe8adf745",
  "status": "hide",
  "serials": [
    "461802000001",
    "461802000002",
    "461802000003"
  ]
}

Get Switch Refresh Status

Request

Retrieve latest refresh status for switches. Returns filtered status report based on requested fields.

Query

fieldsArray of arrays

Fields to include in response. Only refreshedTime is currently supported. If omitted, refreshedTime will be returned by default.

Items Value"refreshedTime"

Example: fields=refreshedTime

No request payload

Responses

Successfully retrieved latest refresh status

Body

refreshedTimestring or null(date-time)

Timestamp when the refresh job was last executed.

Example: "2025-08-08T04:41:00.635894Z"

Response

Refresh Switches

Request

Initiates a refresh operation for switches and synchronizes the latest switches data to the database.

Body

required

statusstringrequired

Value"refresh"

{
  "status": "refresh"
}

Responses

Refresh action triggered successfully

Body

refreshedTimestring

requestIdstring

Response

{
  "refreshedTime": "string",
  "requestId": "string"
}

Update Access Points Status

Request

Updates the operational status of access points.

Body

required

serialsArray of stringsrequired

List of device serial numbers to perform the action on.

Example: ["461802000001","461802000002","461802000001"]

statusstringrequired

Management action to perform on the specified devices.

Value"hide"

Example: "hide"

{
  "serials": [
    "461802000001",
    "461802000002",
    "461802000001"
  ],
  "status": "hide"
}

Responses

Access Points status updated successfully

Body

messagestring

A message describing the result of the operation.

Example: "Switches added to hidden devices successfully."

requestIdstring

Unique identifier for tracking the request.

Example: "902af641-b8c3-4b9f-bd71-2c3fe8adf745"

statusstring

Status of the management operation execution.

Value"hide"

Example: "hide"

serialsArray of strings

List of device serial numbers that were processed in this operation.

Example: ["461802000001","461802000002","461802000003"]

Response

{
  "message": "Switches added to hidden devices successfully.",
  "requestId": "902af641-b8c3-4b9f-bd71-2c3fe8adf745",
  "status": "hide",
  "serials": [
    "461802000001",
    "461802000002",
    "461802000003"
  ]
}

Get AP Refresh Status

Request

Retrieve latest refresh status for access points. Returns filtered status report based on requested fields.

Query

fieldsArray of arrays

Fields to include in response. Only refreshedTime is currently supported. If omitted, refreshedTime will be returned by default.

Items Value"refreshedTime"

Example: fields=refreshedTime

No request payload

Responses

Successfully retrieved latest refresh status

Body

refreshedTimestring or null(date-time)

Timestamp when the refresh job was last executed.

Example: "2025-08-08T04:41:00.635894Z"

Response

Refresh Access Points

Request

Initiates a refresh operation for access points and synchronizes the latest access point data to the database.

Body

required

statusstringrequired

Value"refresh"

{
  "status": "refresh"
}

Responses

Refresh action triggered successfully

Body

refreshedTimestring

requestIdstring

Response

{
  "refreshedTime": "string",
  "requestId": "string"
}