Skip to content
Events and Alarms/
/
Get Alarms Meta Data

Events and Alarms (v0.0.3)

Download OpenAPI description
Download PDF
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

Event

APIs for retrieving and managing event data.

Operations

Alarm

APIs for retrieving and managing alarm data.

Operations

Get Alarms

Request

Returns the set of alarms. Added the support for MSP tenant. For MSP tenant need to pass tenant ids and sort order.

Body
required
fieldsArray of stringsunique

Fields to be returned in response.

sortFieldstring

Field to sort the results on.

sortOrderstring

The order in which results should be sorted.

Enum"asc""desc"
pageinteger(int32)

Page number for pagination.

pageSizeinteger(int32)

Page size for pagination.

filtersobject

Filters for the query.

mspEcTenantsArray of strings

MSP EC tenants filter for the query.

{
  "fields": [
    "string"
  ],
  "sortField": "string",
  "sortOrder": "asc",
  "page": 0,
  "pageSize": 0,
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mspEcTenants": [
    "string"
  ]
}

Responses

successful operation

Body
requestIdstring

Request ID associated with the error.

errorobject(Error)

Detailed information about the error that occurred.

errorsArray of objects(Error)

A collection of error objects if multiple errors occurred.

dataArray of objects

Alarm information.

fieldsArray of strings

Relevant fields.

totalCountinteger(int32)

The total number of alarms matching the query.

subsequentQueriesArray of objects

Subsequent queries.

statusstring

The current status of the alarm data request.

mspEcAlarmCountListArray of objects(Msp Ec Alarm Count)

MSP EC Alarm Count.

Response
{
  "requestId": "string",
  "error": {
    "code": "string",
    "message": "string",
    "reason": "string",
    "suggestion": "string"
  },
  "errors": [
    { … }
  ],
  "data": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "subsequentQueries": [
    { … }
  ],
  "status": "string",
  "mspEcAlarmCountList": [
    { … }
  ]
}

Get Alarms Meta Data

Request

Get all alarms filtered by the query. Includes venue, access point and network data.

Body
required
fieldsArray of stringsunique

Fields to be returned in response.

filtersobject

Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

{
  "fields": [
    "string"
  ],
  "filters": {
    "property1": null,
    "property2": null
  }
}

Responses

successful operation

Body
requestIdstring

Request ID associated with the error.

errorobject(Error)

Detailed information about the error that occurred.

errorsArray of objects(Error)

A collection of error objects if multiple errors occurred.

dataArray of objects

Alarm information.

fieldsArray of strings

Relevant fields.

totalCountinteger(int32)

The total number of alarms matching the query.

subsequentQueriesArray of objects

Subsequent queries.

statusstring

The current status of the alarm data request.

mspEcAlarmCountListArray of objects(Msp Ec Alarm Count)

MSP EC Alarm Count.

Response
{
  "requestId": "string",
  "error": {
    "code": "string",
    "message": "string",
    "reason": "string",
    "suggestion": "string"
  },
  "errors": [
    { … }
  ],
  "data": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "subsequentQueries": [
    { … }
  ],
  "status": "string",
  "mspEcAlarmCountList": [
    { … }
  ]
}

Clear Alarm

Request

Clear the alarm.

Path
alarmIdstringrequired
Body
string
"string"

Responses

successful operation

Response
No content

Group Members Last login Event

Operations