Ruckus Cloud - Tenant API and Model Documentation (v20.01.04b)

License: Ruckus Cloud Privacy Policy Terms of Service

Authentication

Token

Security Scheme Type	OAuth2
password OAuth Flow	Token URL: https://cloudalto.ruckuswireless.com/token Scopes: `all` - Grant access

Authentication

Request authentication token

v20.02.11 will also save an authentication cookie

Request Body schema: application/json

Credentials

username	string
password	string

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

423

Locked

500

Internal Server Error

post /token

https://ruckus.cloud/token

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"username": "string",
"password": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"API-KEY": "string",
"token": "string"
}

Tenant

Get tenant details

Authorizations:

Token (all)

path Parameters

tenantId

required

string

Tenant ID

query Parameters

deep	boolean Set to "true" to include sub-entities in the response

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}

https://ruckus.cloud/api/tenant/{tenantId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"admins": 
[
{"adminRoles": 
[
{"createdDate": "2020-05-07T22:35:28Z",
"delegated": "string",
"id": "string",
"role": "PRIME_ADMIN",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"createdDate": "2020-05-07T22:35:28Z",
"dateFormat": "mm/dd/yyyy",
"detailLevel": "ba",
"externalId": "string",
"id": "string",
"updatedDate": "2020-05-07T22:35:28Z",
"username": "string"
}
],
"createdDate": "2020-05-07T22:35:28Z",
"delegationsTo": 
[
{"createdDate": "2020-05-07T22:35:28Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2020-05-07T22:35:28Z",
"id": "string",
"isValid": true,
"status": "INVITED",
"type": "VAR",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"externalId": "string",
"externalModifiedDate": "2020-05-07T22:35:28Z",
"id": "string",
"maintenanceDate": "2020-05-07T22:35:28Z",
"maintenanceState": true,
"msp": 
{"changePasswordUrl": "string",
"contactSupportUrl": "string",
"contractSupportBehavior": "string",
"email": "string",
"isDisableNotification": true,
"logoUUID": "string",
"mspFQDN": "string",
"mspLabel": "string",
"myOpenCaseBehavior": "string",
"myOpenCaseUrl": "string",
"openCaseBehavior": "string",
"openCaseUrl": "string",
"phone": "string",
"website": "string"
},
"mspEc": 
{"parentMspId": "string",
"serviceEffectiveDate": "2020-05-07T22:35:28Z",
"serviceExpirationDate": "2020-05-07T22:35:28Z"
},
"name": "string",
"notificationRecipients": 
[
{"createdDate": "2020-05-07T22:35:28Z",
"description": "string",
"endpoints": 
[
{"active": true,
"createdDate": "2020-05-07T22:35:28Z",
"destination": "string",
"id": "string",
"status": "OK",
"type": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"id": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"ruckusUser": true,
"status": "active",
"updatedDate": "2020-05-07T22:35:28Z"
}

Get account details

path Parameters

tenantId

required

string

Tenant ID

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/account

https://ruckus.cloud/api/tenant/{tenantId}/account

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"address": "string",
"city": "string",
"country": "string",
"organization": "string",
"stateOrProvince": "string",
"zip": "string"
}

Venue

Manage venues

Get the venue list

path Parameters

tenantId

required

string

Tenant ID

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/venue

https://ruckus.cloud/api/tenant/{tenantId}/venue

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"address": 
{"addressLine": "string",
"city": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"notes": "string",
"timezone": "string"
},
"createdDate": "2020-05-07T22:35:28Z",
"description": "string",
"floorPlans": 
[
{"createdDate": "2020-05-07T22:35:28Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"id": "string",
"name": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
]

Create a venue

path Parameters

tenantId

required

string

Tenant ID

Request Body schema: application/json

Venue

address	object (Address)
description	string The venue description
name	string [ 2 .. 32 ] characters

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", CFGC-10000: "Internal Server Error", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error"]

post /api/tenant/{tenantId}/venue

https://ruckus.cloud/api/tenant/{tenantId}/venue

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"address": 
{"addressLine": "string",
"city": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"notes": "string",
"timezone": "string"
},
"description": "string",
"name": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string",
"response": 
{"address": 
{"addressLine": "string",
"city": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"notes": "string",
"timezone": "string"
},
"createdDate": "2020-05-07T22:35:28Z",
"description": "string",
"floorPlans": 
[
{"createdDate": "2020-05-07T22:35:28Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"id": "string",
"name": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
}

Delete venues

path Parameters

tenantId

required

string

Tenant ID

Request Body schema: application/json

List of Venue IDs

Array

string

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", CFGC-10000: "Internal Server Error", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error"]

delete /api/tenant/{tenantId}/venue

https://ruckus.cloud/api/tenant/{tenantId}/venue

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


["string"
]

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string"
}

Get venue details

path Parameters

tenantId required	string Tenant ID
venueId required	string Venue ID

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/venue/{venueId}

https://ruckus.cloud/api/tenant/{tenantId}/venue/{venueId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"address": 
{"addressLine": "string",
"city": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"notes": "string",
"timezone": "string"
},
"createdDate": "2020-05-07T22:35:28Z",
"description": "string",
"floorPlans": 
[
{"createdDate": "2020-05-07T22:35:28Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"id": "string",
"name": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}

Update a venue

path Parameters

tenantId required	string Tenant ID
venueId required	string Venue ID

Request Body schema: application/json

Venue

address	object (Address)
description	string The venue description
name	string [ 2 .. 32 ] characters

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", CFGC-10000: "Internal Server Error", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error"]

put /api/tenant/{tenantId}/venue/{venueId}

https://ruckus.cloud/api/tenant/{tenantId}/venue/{venueId}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"address": 
{"addressLine": "string",
"city": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"notes": "string",
"timezone": "string"
},
"description": "string",
"name": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string",
"response": 
{"address": 
{"addressLine": "string",
"city": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"notes": "string",
"timezone": "string"
},
"createdDate": "2020-05-07T22:35:28Z",
"description": "string",
"floorPlans": 
[
{"createdDate": "2020-05-07T22:35:28Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"id": "string",
"name": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
}

Delete a venue

path Parameters

tenantId required	string Tenant ID
venueId required	string Venue ID

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", CFGC-10000: "Internal Server Error", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error"]

delete /api/tenant/{tenantId}/venue/{venueId}

https://ruckus.cloud/api/tenant/{tenantId}/venue/{venueId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string"
}

Administrator

Manage administrators

Get the administrator list

path Parameters

tenantId

required

string

Tenant ID

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/admin

https://ruckus.cloud/api/tenant/{tenantId}/admin

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"detailLevel": "ba",
"email": "string",
"externalId": "string",
"id": "string",
"lastLogin": "string",
"lastName": "string",
"name": "string",
"role": "PRIME_ADMIN"
}
]

Add an administrator

path Parameters

tenantId

required

string

Tenant ID

Request Body schema: application/json

Admin

detailLevel	string Enum: "ba" "it" "su" "debug"
email	string IDM username
externalId	string IDM SWU ID
role required	string Enum: "PRIME_ADMIN" "ADMIN" "READ_ONLY" "OFFICE_ADMIN" "SUPPORT" "DEVOPS" Role for this tenant

Responses

200

202

Accepted

400

Bad/malformed request [TNT-10300: "Admin already invited to different account", TNT-10302: "Admin already registered to Ruckus Support", TNT-10303: "Admin already exists"]

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

post /api/tenant/{tenantId}/admin

https://ruckus.cloud/api/tenant/{tenantId}/admin

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"detailLevel": "ba",
"email": "string",
"externalId": "string",
"role": "PRIME_ADMIN"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string",
"response": 
{"adminRoles": 
[
{"createdDate": "2020-05-07T22:35:28Z",
"delegated": "string",
"id": "string",
"role": "PRIME_ADMIN",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"createdDate": "2020-05-07T22:35:28Z",
"dateFormat": "mm/dd/yyyy",
"detailLevel": "ba",
"externalId": "string",
"id": "string",
"updatedDate": "2020-05-07T22:35:28Z",
"username": "string"
}
}

Update an administrator

path Parameters

tenantId

required

string

Tenant ID

Request Body schema: application/json

Admin

detailLevel	string Enum: "ba" "it" "su" "debug"
email	string IDM username
externalId	string IDM SWU ID
role required	string Enum: "PRIME_ADMIN" "ADMIN" "READ_ONLY" "OFFICE_ADMIN" "SUPPORT" "DEVOPS" Role for this tenant

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

put /api/tenant/{tenantId}/admin

https://ruckus.cloud/api/tenant/{tenantId}/admin

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"detailLevel": "ba",
"email": "string",
"externalId": "string",
"role": "PRIME_ADMIN"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string",
"response": 
{"adminRoles": 
[
{"createdDate": "2020-05-07T22:35:28Z",
"delegated": "string",
"id": "string",
"role": "PRIME_ADMIN",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"createdDate": "2020-05-07T22:35:28Z",
"dateFormat": "mm/dd/yyyy",
"detailLevel": "ba",
"externalId": "string",
"id": "string",
"updatedDate": "2020-05-07T22:35:28Z",
"username": "string"
}
}

Delete administrators

path Parameters

tenantId

required

string

Tenant ID

Request Body schema: application/json

List of administrator IDs

Array

string

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

delete /api/tenant/{tenantId}/admin

https://ruckus.cloud/api/tenant/{tenantId}/admin

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


["string"
]

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string"
}

Get administrator details

path Parameters

tenantId required	string Tenant ID
adminId required	string Administrator ID

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/admin/{adminId}

https://ruckus.cloud/api/tenant/{tenantId}/admin/{adminId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"detailLevel": "ba",
"email": "string",
"externalId": "string",
"id": "string",
"lastLogin": "string",
"lastName": "string",
"name": "string",
"role": "PRIME_ADMIN"
}

Delete administrator

path Parameters

tenantId required	string Tenant ID
adminId required	string Administrator ID

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

delete /api/tenant/{tenantId}/admin/{adminId}

https://ruckus.cloud/api/tenant/{tenantId}/admin/{adminId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string"
}

Delegation

Manage delegations

Get the delegation list

path Parameters

tenantId

required

string

Tenant ID

query Parameters

type	string Enum: "VAR" "SUPPORT" "MSP" "SUPPORT_EC" type

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/delegation

https://ruckus.cloud/api/tenant/{tenantId}/delegation

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"createdDate": "2020-05-07T22:35:28Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2020-05-07T22:35:28Z",
"id": "string",
"isValid": true,
"status": "INVITED",
"type": "VAR",
"updatedDate": "2020-05-07T22:35:28Z"
}
]

Invite VAR delegation

path Parameters

tenantId

required

string

Tenant ID

Request Body schema: application/json

Invite VAR

username

string

The VAR user name

Responses

200

202

Accepted

400

Bad/malformed request [TNT-10304: "You cannot invite support user as a VAR",

401

Not-authenticated

403

Not-authorized

404

Requested Resource or Related-Entity Not Found [TNT-10301: "VAR not found in Ruckus Support"]

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

post /api/tenant/{tenantId}/delegation

https://ruckus.cloud/api/tenant/{tenantId}/delegation

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"username": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string",
"response": 
{"createdDate": "2020-05-07T22:35:28Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2020-05-07T22:35:28Z",
"id": "string",
"isValid": true,
"status": "INVITED",
"type": "VAR",
"updatedDate": "2020-05-07T22:35:28Z"
}
}

Grant Support access

path Parameters

tenantId

required

string

Tenant ID

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

post /api/tenant/{tenantId}/delegation/support

https://ruckus.cloud/api/tenant/{tenantId}/delegation/support

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string",
"response": 
{"createdDate": "2020-05-07T22:35:28Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2020-05-07T22:35:28Z",
"id": "string",
"isValid": true,
"status": "INVITED",
"type": "VAR",
"updatedDate": "2020-05-07T22:35:28Z"
}
}

Revoke Support access

path Parameters

tenantId

required

string

Tenant ID

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

delete /api/tenant/{tenantId}/delegation/support

https://ruckus.cloud/api/tenant/{tenantId}/delegation/support

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string"
}

Get delegation details

path Parameters

tenantId required	string Tenant ID
delegationId required	string Delegation ID

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/delegation/{delegationId}

https://ruckus.cloud/api/tenant/{tenantId}/delegation/{delegationId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"createdDate": "2020-05-07T22:35:28Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2020-05-07T22:35:28Z",
"id": "string",
"isValid": true,
"status": "INVITED",
"type": "VAR",
"updatedDate": "2020-05-07T22:35:28Z"
}

Accept or reject a delegation

path Parameters

tenantId required	string Tenant ID
delegationId required	string Delegation ID

Request Body schema: application/json

Accept VAR

boolean

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

put /api/tenant/{tenantId}/delegation/{delegationId}

https://ruckus.cloud/api/tenant/{tenantId}/delegation/{delegationId}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"accept": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string",
"response": 
{"createdDate": "2020-05-07T22:35:28Z",
"delegatedBy": "string",
"delegatedTo": "string",
"delegatedToAdmin": "string",
"delegatedToName": "string",
"expiryDate": "2020-05-07T22:35:28Z",
"id": "string",
"isValid": true,
"status": "INVITED",
"type": "VAR",
"updatedDate": "2020-05-07T22:35:28Z"
}
}

Revoke a VAR delegation

path Parameters

tenantId required	string Tenant ID
delegationId required	string Delegation ID

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

delete /api/tenant/{tenantId}/delegation/{delegationId}

https://ruckus.cloud/api/tenant/{tenantId}/delegation/{delegationId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string"
}

Notification Recipient

Manage notification recipients

Get the notification-recipient list

path Parameters

tenantId

required

string

Tenant ID

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/notification-recipient

https://ruckus.cloud/api/tenant/{tenantId}/notification-recipient

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"createdDate": "2020-05-07T22:35:28Z",
"description": "string",
"endpoints": 
[
{"active": true,
"createdDate": "2020-05-07T22:35:28Z",
"destination": "string",
"id": "string",
"status": "OK",
"type": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"id": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
]

Create a notification-recipient

path Parameters

tenantId

required

string

Tenant ID

Request Body schema: application/json

Notification-recipient

description required	string The description of the notification recipient
endpoints required	Array of objects (NotificationEndpoint)

Responses

200

202

Accepted

400

Bad/malformed request [TNT-10100: "Duplicate notification endpoint"]

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

post /api/tenant/{tenantId}/notification-recipient

https://ruckus.cloud/api/tenant/{tenantId}/notification-recipient

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"endpoints": 
[
{"active": true,
"destination": "string",
"status": "OK",
"type": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string",
"response": 
{"createdDate": "2020-05-07T22:35:28Z",
"description": "string",
"endpoints": 
[
{"active": true,
"createdDate": "2020-05-07T22:35:28Z",
"destination": "string",
"id": "string",
"status": "OK",
"type": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"id": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
}

Delete notification-recipients

path Parameters

tenantId

required

string

Tenant ID

Request Body schema: application/json

List of notification-recipients

Array

description required	string The description of the notification recipient
endpoints required	Array of objects (NotificationEndpoint)

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

delete /api/tenant/{tenantId}/notification-recipient

https://ruckus.cloud/api/tenant/{tenantId}/notification-recipient

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


[
{"description": "string",
"endpoints": 
[
{"active": true,
"destination": "string",
"status": "OK",
"type": "string"
}
]
}
]

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string"
}

Get notification-recipient details

path Parameters

tenantId required	string Tenant ID
notificationRecipientId required	string Notification-recipient ID

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/notification-recipient/{notificationRecipientId}

https://ruckus.cloud/api/tenant/{tenantId}/notification-recipient/{notificationRecipientId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"createdDate": "2020-05-07T22:35:28Z",
"description": "string",
"endpoints": 
[
{"active": true,
"createdDate": "2020-05-07T22:35:28Z",
"destination": "string",
"id": "string",
"status": "OK",
"type": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"id": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}

Update a notification-recipient

path Parameters

tenantId required	string Tenant ID
notificationRecipientId required	string Notification-recipient ID

Request Body schema: application/json

Notification-recipient

description required	string The description of the notification recipient
endpoints required	Array of objects (NotificationEndpoint)

Responses

200

202

Accepted

400

Bad/malformed request [TNT-10100: "Duplicate notification endpoint"]

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

put /api/tenant/{tenantId}/notification-recipient/{notificationRecipientId}

https://ruckus.cloud/api/tenant/{tenantId}/notification-recipient/{notificationRecipientId}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"description": "string",
"endpoints": 
[
{"active": true,
"destination": "string",
"status": "OK",
"type": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string",
"response": 
{"createdDate": "2020-05-07T22:35:28Z",
"description": "string",
"endpoints": 
[
{"active": true,
"createdDate": "2020-05-07T22:35:28Z",
"destination": "string",
"id": "string",
"status": "OK",
"type": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"id": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
}

Delete a notification-recipient

path Parameters

tenantId required	string Tenant ID
notificationRecipientId required	string Notification-recipient ID

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

delete /api/tenant/{tenantId}/notification-recipient/{notificationRecipientId}

https://ruckus.cloud/api/tenant/{tenantId}/notification-recipient/{notificationRecipientId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string"
}

User-Profile

Manage your user profile

Get user profile

path Parameters

tenantId

required

string

Tenant ID

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/user-profile

https://ruckus.cloud/api/tenant/{tenantId}/user-profile

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"adminId": true,
"allowedRegions": 
[
{"current": true,
"description": "string",
"link": "string",
"name": "string"
}
],
"companyName": "string",
"dateFormat": "mm/dd/yyyy",
"detailLevel": "ba",
"email": "string",
"externalId": "string",
"firstName": "string",
"lastName": "string",
"roles": 
["string"
],
"tenantId": "string",
"username": "string",
"var": true,
"varTenantId": "string"
}

Update a user profile

path Parameters

tenantId

required

string

Tenant ID

Request Body schema: application/json

User profile

dateFormat required	string Enum: "mm/dd/yyyy" "dd/mm/yyyy" "yyyy/mm/dd"
detailLevel required	string Enum: "ba" "it" "su" "debug"

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]

put /api/tenant/{tenantId}/user-profile

https://ruckus.cloud/api/tenant/{tenantId}/user-profile

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"dateFormat": "mm/dd/yyyy",
"detailLevel": "ba"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string",
"response": 
{"adminId": true,
"allowedRegions": 
[
{"current": true,
"description": "string",
"link": "string",
"name": "string"
}
],
"companyName": "string",
"dateFormat": "mm/dd/yyyy",
"detailLevel": "ba",
"email": "string",
"externalId": "string",
"firstName": "string",
"lastName": "string",
"roles": 
["string"
],
"tenantId": "string",
"username": "string",
"var": true,
"varTenantId": "string"
}
}

Entitlement

Manage entitlements (licenses)

Get the entitlement list

path Parameters

tenantId

required

string

Tenant ID

query Parameters

type	string Enum: "WIFI" "LTE" "SWITCH" Filter by device type (optional)

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/entitlement

https://ruckus.cloud/api/tenant/{tenantId}/entitlement

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"assignedLicense": true,
"createdDate": "2020-05-07T22:35:28Z",
"deviceSubType": "string",
"deviceType": "UNASSIGNED_DEVICE_TYPE",
"effectiveDate": "2020-05-07T22:35:28Z",
"expirationDate": "2020-05-07T22:35:28Z",
"externalId": "string",
"graceEndDate": "2020-05-07T22:35:28Z",
"historical": true,
"id": "string",
"quantity": 0,
"sku": "string",
"tempLicense": true,
"updatedDate": "2020-05-07T22:35:28Z"
}
]

Get entitlement summary

path Parameters

tenantId

required

string

Tenant ID

query Parameters

type	string Enum: "WIFI" "LTE" "SWITCH" Filter by device type (optional)

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/entitlement/summary

https://ruckus.cloud/api/tenant/{tenantId}/entitlement/summary

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"deviceCount": 0,
"deviceSubType": "string",
"deviceType": "UNASSIGNED_DEVICE_TYPE",
"effectiveDate": "2020-05-07T22:35:28Z",
"errorCode": "string",
"expirationDate": "2020-05-07T22:35:28Z",
"internalMessage": "string",
"quantity": 0,
"remainingDays": 0,
"remainingDevices": 0,
"sku": "string"
}
]

Refresh entitlements

path Parameters

tenantId required	string Tenant ID
mspEcTenantId required	string MSP End-Customer Tenant ID

query Parameters

type	string Enum: "WIFI" "LTE" "SWITCH" Filter by device type (optional)

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

post /api/tenant/{tenantId}/entitlement/refresh

https://ruckus.cloud/api/tenant/{tenantId}/entitlement/refresh

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"entitlements": 
[
{"assignedLicense": true,
"createdDate": "2020-05-07T22:35:28Z",
"deviceSubType": "string",
"deviceType": "UNASSIGNED_DEVICE_TYPE",
"effectiveDate": "2020-05-07T22:35:28Z",
"expirationDate": "2020-05-07T22:35:28Z",
"externalId": "string",
"graceEndDate": "2020-05-07T22:35:28Z",
"historical": true,
"id": "string",
"quantity": 0,
"sku": "string",
"tempLicense": true,
"updatedDate": "2020-05-07T22:35:28Z"
}
],
"summary": 
[
{"deviceCount": 0,
"deviceSubType": "string",
"deviceType": "UNASSIGNED_DEVICE_TYPE",
"effectiveDate": "2020-05-07T22:35:28Z",
"errorCode": "string",
"expirationDate": "2020-05-07T22:35:28Z",
"internalMessage": "string",
"quantity": 0,
"remainingDays": 0,
"remainingDevices": 0,
"sku": "string"
}
]
}

Request

Retrieve asynchronous-request details

Get request details

Get transaction request details

path Parameters

tenantId required	string Tenant ID
requestId required	string Request ID

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/request/{requestId}

https://ruckus.cloud/api/tenant/{tenantId}/request/{requestId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"admin": "string",
"count": 0,
"entityId": "string",
"method": "string",
"requestId": "string",
"serviceName": "string",
"status": "PENDING",
"tenantId": "string",
"timestamp": "2020-05-07T22:35:28Z"
}

Get request list by status

Get transaction requests by status

path Parameters

tenantId required	string Tenant ID
status required	string Enum: "PENDING" "SUCCESS" "FAIL" Status

query Parameters

page	string Page number
size	string Page size

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/request/status/{status}

https://ruckus.cloud/api/tenant/{tenantId}/request/status/{status}

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"admin": "string",
"count": 0,
"entityId": "string",
"method": "string",
"requestId": "string",
"serviceName": "string",
"status": "PENDING",
"tenantId": "string",
"timestamp": "2020-05-07T22:35:28Z"
}
]

Floor-Plan

Get the floor-plan list

path Parameters

tenantId required	string Tenant ID
venueId required	string Venue ID

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/venue/{venueId}/floor-plan

https://ruckus.cloud/api/tenant/{tenantId}/venue/{venueId}/floor-plan

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"createdDate": "2020-05-07T22:35:28Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
]

Create a floor-plan

path Parameters

tenantId required	string Tenant ID
venueId required	string Venue ID

Request Body schema: application/json

Floor-plan

floorNumber	integer <int32>
imageId	string Use File upload-url API to obtain a FileId for this parameter
name	string The floor plan name

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error"]

post /api/tenant/{tenantId}/venue/{venueId}/floor-plan

https://ruckus.cloud/api/tenant/{tenantId}/venue/{venueId}/floor-plan

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"floorNumber": 0,
"imageId": "string",
"name": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string",
"response": 
{"createdDate": "2020-05-07T22:35:28Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
}

Get floor-plan details

path Parameters

tenantId required	string Tenant ID
venueId required	string Venue ID
floorPlanId required	string Floor-plan ID

Responses

200

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error

get /api/tenant/{tenantId}/venue/{venueId}/floor-plan/{floorPlanId}

https://ruckus.cloud/api/tenant/{tenantId}/venue/{venueId}/floor-plan/{floorPlanId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"createdDate": "2020-05-07T22:35:28Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}

Update a floor-plan

path Parameters

tenantId required	string Tenant ID
venueId required	string Venue ID
floorPlanId required	string Floor-plan ID

Request Body schema: application/json

Floor-plan

floorNumber	integer <int32>
imageId	string Use File upload-url API to obtain a FileId for this parameter
name	string The floor plan name

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error"]

put /api/tenant/{tenantId}/venue/{venueId}/floor-plan/{floorPlanId}

https://ruckus.cloud/api/tenant/{tenantId}/venue/{venueId}/floor-plan/{floorPlanId}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"floorNumber": 0,
"imageId": "string",
"name": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string",
"response": 
{"createdDate": "2020-05-07T22:35:28Z",
"floorNumber": 0,
"id": "string",
"imageId": "string",
"imageUrl": "string",
"name": "string",
"updatedDate": "2020-05-07T22:35:28Z"
}
}

Delete a floor-plan

path Parameters

tenantId required	string Tenant ID
venueId required	string Venue ID
floorPlanId required	string Floor-plan ID

Responses

200

202

Accepted

400

Bad/malformed request

401

Not-authenticated

403

Not-authorized

404

Requested resource or related-entity not found

422

Validation error

423

Locked

500

Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error"]

delete /api/tenant/{tenantId}/venue/{venueId}/floor-plan/{floorPlanId}

https://ruckus.cloud/api/tenant/{tenantId}/venue/{venueId}/floor-plan/{floorPlanId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"requestId": "string"
}

File

Get a URL to upload a file

path Parameters

tenantId

required

string

Tenant ID

Request Body schema: application/json

Upload details

fileExtension

string

The file extension

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post /api/file/tenant/{tenantId}/upload-url

https://ruckus.cloud/api/file/tenant/{tenantId}/upload-url

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"fileExtension": "string"
}

Get Download-URL from FileID

path Parameters

tenantId required	string Tenant ID
fileId required	string File ID

Responses

302

Redirection to actual location of file. Call the redirected URL without headers, otherwise the redirect will fail with a 403 error.

401

Unauthorized

403

Forbidden

404

Not Found

get /api/file/tenant/{tenantId}/{fileId}

https://ruckus.cloud/api/file/tenant/{tenantId}/{fileId}