Please login to access that KB Article

R1 Postman for API on Array of Strings

Summary

This article explains how to use Postman with Ruckus One (R1) Cloud APIs to retrieve and work with arrays of strings in API responses. It includes examples of GET and POST requests, regional API endpoints, and sample JSON output demonstrating string?based fields such as MAC addresses, OS type, and device identifiers.

Question

How can Postman be used with Ruckus One (R1) Cloud APIs to handle arrays of strings in GET and POST API requests?

This includes:

  • Retrieving arrays of strings using GET commands
  • Sending arrays of strings

Customer Environment

Platform: Ruckus One (R1) Cloud Tools: Postman Interface: REST API

Symptoms

  • Customer is unsure how to retrieve an array of strings from R1 APIs using Postman
  • Confusion between using GET versus POST methods for APIs that return string?based data
  • Difficulty formatting request bodies when arrays of strings are required



 

Root Cause

This is not a defect. The confusion arises from misunderstanding API method usage, specifically: When a request body is required (POST/PUT) When an array of strings is returned directly in a response (GET)

Troubleshooting Steps

1. Using Arrays of Strings in POST Requests

For APIs that require a request body (such as POST or PUT), the array of strings must be added in the Body section of Postman.

Refer to the official Ruckus One API documentation for supported request formats:
https://docs.ruckus.cloud/api/

Note: PUT commands always require a request body, whereas GET commands do not.


2. Using GET Requests to Retrieve Arrays of Strings

Many R1 APIs return arrays of strings directly in their response payload. These can be accessed using GET requests without specifying a body.

Region?specific Client API Endpoints


3. Retrieving AP Information (Array of Strings)

Use the following GET calls to retrieve AP?related data:


4. Retrieving Venue ID

To obtain a venue ID required for venue?specific API queries:

GET https://api.<region>.ruckus.cloud/api/tenant/{tenantId}/venue

Resolution

When using Postman with Ruckus One APIs:

  • Use GET requests to retrieve arrays of strings (for example, client or AP information)
  • Use POST or PUT requests only when the API explicitly requires a request body
  • No POST command is required when the API endpoint already returns data through GET

Example JSON Output (Array of Strings)

The following example shows a typical response for a client record retrieved via a GET request:

{
"mac": "00:00:00:00:00:00",
"apMac": "00:00:00:00:00:00",
"osType": "Android",
"venueId": "xxxxxxxxxxxxxxx",
"connectedSince": "2025-07-08T05:03:04Z",
"apSerialNumber": "xxxxxxxxx",
"networkId": "xxxxxxxxxxxxxxx",
"ip": "0.0.0.0",
"username": "xyz",
"hostname": "username",
"ssid": "SSIDname",
"vlan": vlanID
},

Attachment 1

API-Array of string for POST.PNG
png
Download
(154 KB)

Attachment 2

API-Get-Clients
png
Download
(83.5 KB)

Attachment 3

API-offline-post for APoffline only status
png
Download
(54.4 KB)

Attachment 4

API_GET-template- Bearer token
png
Download
(151 KB)

Attachment 5

API-APstatus
png
Download
(93.7 KB)

Attachment 6

API-POST-Tenant-Token
png
Download
(224 KB)

Related Articles

000014355

Article Number:
000014923

Updated:
January 29, 2026 05:58 AM (4 months ago)

Answer Attachment 1
API-Array of string for POST.PNG
png
Download
(154 KB)

Answer Attachment 2
API-Get-Clients
png
Download
(83.5 KB)

Answer Attachment 3
API-offline-post for APoffline only status
png
Download
(54.4 KB)

Answer Attachment 4
API_GET-template- Bearer token
png
Download
(151 KB)

Answer Attachment 5
API-APstatus
png
Download
(93.7 KB)

Answer Attachment 6
API-POST-Tenant-Token
png
Download
(224 KB)

Tags:
Troubleshooting, Installation, Configuration, Cloud Services

Votes:
0

This article is:
helpful
not helpful

Working...Please wait

This is here to prevent you from accidentally submitting twice.

The page will automatically refresh.

Alert!!

Close