Skip to content

Venues (0.2.9)

Ruckus Network Technical Documents

Overview

Rate Limit

For the REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 200 calls can be made per second.
  • Each second 100 calls will be returned to be used.
Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud/
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud/
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud/

Floor Plan

Manage floor plans.

Operations

Venue Template

Manage venue template.

Operations

Venue

Manage venue.

Operations

Access Venue by ID

Request

Get venue.

Path
venueIdstringrequired
No request payload

Responses

OK

Body
idstring

Venue identifier

namestring[ 2 .. 63 ] characters\s*\S+\s*\S+.*required

Venue name

descriptionstring

Venue description

addressobject(AddressView)required

Address

address.​countrystringrequired

Country

address.​countryCodestring

Country code

address.​citystringrequired

City name

address.​addressLinestring

Address line

address.​latitudenumber(double)

Latitude

address.​longitudenumber(double)

Longitude

address.​timezonestring

Timezone

address.​notesstring

Notes

tagsArray of strings

Venue tags

isTemplateboolean

Checked if its created as a template.

isEnforcedboolean

Checked if its allowed to be updated.

templateContextstring

Checked if its for MSP or MSP-EC.

Response
{
  "id": "string",
  "name": "string",
  "description": "string",
  "address": {
    "country": "string",
    "countryCode": "string",
    "city": "string",
    "addressLine": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "timezone": "string",
    "notes": "string"
  },
  "tags": [
    "string"
  ],
  "isTemplate": true,
  "isEnforced": true,
  "templateContext": "string"
}

Replace Venue

Request

Update venue.

Path
venueIdstringrequired
Body
required
idstring

Venue identifier

namestring[ 2 .. 63 ] characters\s*\S+\s*\S+.*required

Venue name

descriptionstring

Venue description

addressobject(AddressView)required

Address

address.​countrystringrequired

Country

address.​countryCodestring

Country code

address.​citystringrequired

City name

address.​addressLinestring

Address line

address.​latitudenumber(double)

Latitude

address.​longitudenumber(double)

Longitude

address.​timezonestring

Timezone

address.​notesstring

Notes

tagsArray of strings

Venue tags

isTemplateboolean

Checked if its created as a template.

isEnforcedboolean

Checked if its allowed to be updated.

templateContextstring

Checked if its for MSP or MSP-EC.

{
  "id": "string",
  "name": "string",
  "description": "string",
  "address": {
    "country": "string",
    "countryCode": "string",
    "city": "string",
    "addressLine": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "timezone": "string",
    "notes": "string"
  },
  "tags": [
    "string"
  ],
  "isTemplate": true,
  "isEnforced": true,
  "templateContext": "string"
}

Responses

Accepted

Body
requestIdstring

Operation request identifier

responseobject(VenueView)

Response payload

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "name": "string",
    "description": "string",
    "address": { … },
    "tags": [ … ],
    "isTemplate": true,
    "isEnforced": true,
    "templateContext": "string"
  }
}

Revoke Venue by ID

Request

Delete venues by ID. WARNING: Note that all network devices under this venue will be removed as well.

Path
venueIdstringrequired
No request payload

Responses

Accepted

Body
requestIdstring

Operation request identifier

responseany

Response payload

Response
{
  "requestId": "string",
  "response": null
}

Request Venue

Request

Create venue.

Body
required
idstring

Venue identifier

namestring[ 2 .. 63 ] characters\s*\S+\s*\S+.*required

Venue name

descriptionstring

Venue description

addressobject(AddressView)required

Address

address.​countrystringrequired

Country

address.​countryCodestring

Country code

address.​citystringrequired

City name

address.​addressLinestring

Address line

address.​latitudenumber(double)

Latitude

address.​longitudenumber(double)

Longitude

address.​timezonestring

Timezone

address.​notesstring

Notes

tagsArray of strings

Venue tags

isTemplateboolean

Checked if its created as a template.

isEnforcedboolean

Checked if its allowed to be updated.

templateContextstring

Checked if its for MSP or MSP-EC.

{
  "id": "string",
  "name": "string",
  "description": "string",
  "address": {
    "country": "string",
    "countryCode": "string",
    "city": "string",
    "addressLine": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "timezone": "string",
    "notes": "string"
  },
  "tags": [
    "string"
  ],
  "isTemplate": true,
  "isEnforced": true,
  "templateContext": "string"
}

Responses

Accepted

Body
requestIdstring

Operation request identifier

responseobject(VenueView)

Response payload

Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "name": "string",
    "description": "string",
    "address": { … },
    "tags": [ … ],
    "isTemplate": true,
    "isEnforced": true,
    "templateContext": "string"
  }
}

Access Venue Tags

Request

Get venue tags.

No request payload

Responses

OK

Body
Array [
string
]
Response
[
  "string"
]