Documentation Powered by ReDoc

Ruckus Cloud - Switch API and Model Documentation (v20.01.12)

License: Ruckus Cloud Privacy Policy Terms of Service

Acl

Acl APIs

Get Acl Venue Id

path Parameters
aclId
required
string

aclId

tenantId
required
string

ALTO Tenant ID

venueId
required
string

venueId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/acl/{aclId}/venue/{venueId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/acl/{aclId}/venue/{venueId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "altoId": "string",
  • "szNameId": "string",
  • "venueId": "string"
}

Get Acls By Venue

List of ACL under a venue

path Parameters
tenantId
required
string

ALTO Tenant ID

venueId
required
string

venueId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profile/acls/venue/{venueId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/acls/venue/{venueId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Add Acl

Add Acl

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

aclRules
Array of objects (AclRule)

default: new HashSet()

aclType
string
Enum: "standard" "extended"
id
string
name
string

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/profile/{profileId}/acl
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/acl

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "aclRules":
    [
    ],
  • "aclType": "standard",
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Update Acl

Update Acl

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

aclRules
Array of objects (AclRule)

default: new HashSet()

aclType
string
Enum: "standard" "extended"
id
string
name
string

Responses

200

OK

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

put/api/switch/tenant/{tenantId}/profile/{profileId}/acl
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/acl

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "aclRules":
    [
    ],
  • "aclType": "standard",
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Acl

Acl

path Parameters
aclId
required
string

aclId

profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profile/{profileId}/acl/{aclId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/acl/{aclId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "aclRules":
    [
    ],
  • "aclType": "standard",
  • "id": "string",
  • "name": "string"
}

Delete Acl

Delete Acl

path Parameters
aclId
required
string

aclId

profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/profile/{profileId}/acl/{aclId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/acl/{aclId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get Acls

List of Acl under a profile

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

query Parameters
page
string

page

size
string

size

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profile/{profileId}/acls
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/acls

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Delete Acls

Delete Acls

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
string

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/profile/{profileId}/acls
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/acls

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

IcxSwitch

IcxSwitch APIs

Get Switches

List of tenant's Switches

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/switch
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Add Switch

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

defaultGateway
string
description
string [ 0 .. 255 ] characters
enableStack
boolean

default: false

id
required
string ^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK|FEL|FJN|FJP|FMD|FME|FMF|FMG|FMU|FMH|FMJ|EZC|EZD|EZE|FLU|FLV|FLW|FLX)([0-9A-Z]{2})(0[1-9]|[1-4][0-9]|5[0-4])([A-HJ-NP-Z])([0-9A-HJ-NPRSTV-Z]{3})$
igmpSnooping
string
Enum: "active" "passive" "none"
ipAddress
string
isPrimaryDeleted
boolean

default: false

jumboMode
boolean

default: false

name
string ^(?:(?!").){1,255}$
position
object (SwitchPosition)

Switch Position object

softDeleted
boolean

default: false

softDeletedDate
string <date-time>
stackMembers
Array of objects (StackMembers)
subnetMask
string
tags
string ^$|^([^,!\-\ ]{2,58})(,[^,!\-\ ]{2,58}){0,4}$
venueId
required
string

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/switch
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "defaultGateway": "string",
  • "description": "string",
  • "enableStack": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipAddress": "string",
  • "isPrimaryDeleted": true,
  • "jumboMode": true,
  • "name": "string",
  • "position":
    {
    },
  • "softDeleted": true,
  • "softDeletedDate": "2020-09-25T06:09:52Z",
  • "stackMembers":
    [
    ],
  • "subnetMask": "string",
  • "tags": "string",
  • "venueId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Update Switch

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

defaultGateway
string
description
string [ 0 .. 255 ] characters
enableStack
boolean

default: false

id
required
string ^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK|FEL|FJN|FJP|FMD|FME|FMF|FMG|FMU|FMH|FMJ|EZC|EZD|EZE|FLU|FLV|FLW|FLX)([0-9A-Z]{2})(0[1-9]|[1-4][0-9]|5[0-4])([A-HJ-NP-Z])([0-9A-HJ-NPRSTV-Z]{3})$
igmpSnooping
string
Enum: "active" "passive" "none"
ipAddress
string
isPrimaryDeleted
boolean

default: false

jumboMode
boolean

default: false

name
string ^(?:(?!").){1,255}$
position
object (SwitchPosition)

Switch Position object

softDeleted
boolean

default: false

softDeletedDate
string <date-time>
stackMembers
Array of objects (StackMembers)
subnetMask
string
tags
string ^$|^([^,!\-\ ]{2,58})(,[^,!\-\ ]{2,58}){0,4}$
venueId
required
string

Responses

200

OK

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

put/api/switch/tenant/{tenantId}/switch
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "defaultGateway": "string",
  • "description": "string",
  • "enableStack": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipAddress": "string",
  • "isPrimaryDeleted": true,
  • "jumboMode": true,
  • "name": "string",
  • "position":
    {
    },
  • "softDeleted": true,
  • "softDeletedDate": "2020-09-25T06:09:53Z",
  • "stackMembers":
    [
    ],
  • "subnetMask": "string",
  • "tags": "string",
  • "venueId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Create Switch Ssh Tunnel

Create reverse SSH tunnel to Switch, execute by the RPoint script

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

localIp
string
localPort
required
integer <int32> [ 0 .. 65535 ]
rpIp
string
rpPort
required
integer <int32> [ 0 .. 65535 ]
rpPrivateKey
string
rpUserName
string
serial
required
string

Responses

200

OK

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/switch/tenant/{tenantId}/switch/tunnel
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch/tunnel

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "localIp": "string",
  • "localPort": 0,
  • "rpIp": "string",
  • "rpPort": 0,
  • "rpPrivateKey": "string",
  • "rpUserName": "string",
  • "serial": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get Switches By Venue

List of Switches under a venue

path Parameters
tenantId
required
string

ALTO Tenant ID

venueId
required
string

venueId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/switch/venue/{venueId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch/venue/{venueId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Switch

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch/{serialNumber}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "defaultGateway": "string",
  • "description": "string",
  • "enableStack": true,
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipAddress": "string",
  • "isPrimaryDeleted": true,
  • "jumboMode": true,
  • "name": "string",
  • "position":
    {
    },
  • "softDeleted": true,
  • "softDeletedDate": "2020-09-25T06:09:53Z",
  • "stackMembers":
    [
    ],
  • "subnetMask": "string",
  • "tags": "string",
  • "venueId": "string"
}

Delete Switch

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch/{serialNumber}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Ack

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

add
Array of strings
remove
Array of strings

Responses

200

OK

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

put/api/switch/tenant/{tenantId}/switch/{serialNumber}/ack
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch/{serialNumber}/ack

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "add":
    [
    ],
  • "remove":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Add Member

path Parameters
memberId
required
string

memberId

serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/switch/{serialNumber}/member/{memberId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch/{serialNumber}/member/{memberId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Ping

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

targetHost
required
string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b)$)

Responses

200

OK

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/switch/tenant/{tenantId}/switch/{serialNumber}/ping
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch/{serialNumber}/ping

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "targetHost": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Update Switch Position

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

floorplanId
string
xPercent
number <float> [ 0 .. 100 ]
yPercent
number <float> [ 0 .. 100 ]

Responses

200

OK

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

put/api/switch/tenant/{tenantId}/switch/{serialNumber}/position
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch/{serialNumber}/position

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "floorplanId": "string",
  • "xPercent": 0,
  • "yPercent": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Reboot Switch

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/switch/{serialNumber}/reboot
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch/{serialNumber}/reboot

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Trace Route

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

maxTtl
integer <int32> [ 0 .. 255 ]

default: 30

targetHost
required
string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b)$)

Responses

200

OK

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/switch/tenant/{tenantId}/switch/{serialNumber}/trace-route
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch/{serialNumber}/trace-route

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "maxTtl": 0,
  • "targetHost": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Upgrade Firmware

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

firmwareVersion
string
scheduledTime
string

Responses

200

OK

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/switch/tenant/{tenantId}/switch/{serialNumber}/upgrade
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switch/{serialNumber}/upgrade

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "firmwareVersion": "string",
  • "scheduledTime": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Add Switches

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
defaultGateway
string
description
string [ 0 .. 255 ] characters
enableStack
boolean

default: false

id
required
string ^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK|FEL|FJN|FJP|FMD|FME|FMF|FMG|FMU|FMH|FMJ|EZC|EZD|EZE|FLU|FLV|FLW|FLX)([0-9A-Z]{2})(0[1-9]|[1-4][0-9]|5[0-4])([A-HJ-NP-Z])([0-9A-HJ-NPRSTV-Z]{3})$
igmpSnooping
string
Enum: "active" "passive" "none"
ipAddress
string
isPrimaryDeleted
boolean

default: false

jumboMode
boolean

default: false

name
string ^(?:(?!").){1,255}$
position
object (SwitchPosition)

Switch Position object

softDeleted
boolean

default: false

softDeletedDate
string <date-time>
stackMembers
Array of objects (StackMembers)
subnetMask
string
tags
string ^$|^([^,!\-\ ]{2,58})(,[^,!\-\ ]{2,58}){0,4}$
venueId
required
string

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/switches
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switches

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    [
    ]
}

Delete Switches

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
string

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/switches
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/switches

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

IpPort

IpPort APIs

Update Ip Port

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

dhcpRelayAgent
string
egressAcl
string
id
string
ingressAcl
string
ipAddress
string
ipSubnetMask
string
name
string
ospfArea
string
port
string ^\d{1,2}/\d{1,2}/\d{1,2}$

Responses

200

OK

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

put/api/switch/tenant/{tenantId}/ipPort
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/ipPort

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dhcpRelayAgent": "string",
  • "egressAcl": "string",
  • "id": "string",
  • "ingressAcl": "string",
  • "ipAddress": "string",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "port": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete Ip Ports

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
string

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/ipPort
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/ipPort

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get Ip Ports By Serial Number

List of Switch's IpPort settings

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/ipPort/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/ipPort/switch/{serialNumber}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Add Ip Port

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

dhcpRelayAgent
string
egressAcl
string
id
string
ingressAcl
string
ipAddress
string
ipSubnetMask
string
name
string
ospfArea
string
port
string ^\d{1,2}/\d{1,2}/\d{1,2}$

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/ipPort/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/ipPort/switch/{serialNumber}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dhcpRelayAgent": "string",
  • "egressAcl": "string",
  • "id": "string",
  • "ingressAcl": "string",
  • "ipAddress": "string",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "port": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Ip Port

path Parameters
ipPortId
required
string

ipPortId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/ipPort/{ipPortId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/ipPort/{ipPortId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dhcpRelayAgent": "string",
  • "egressAcl": "string",
  • "id": "string",
  • "ingressAcl": "string",
  • "ipAddress": "string",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "port": "string"
}

Delete Ip Port

path Parameters
ipPortId
required
string

ipPortId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/ipPort/{ipPortId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/ipPort/{ipPortId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Add Ip Ports

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
dhcpRelayAgent
string
egressAcl
string
id
string
ingressAcl
string
ipAddress
string
ipSubnetMask
string
name
string
ospfArea
string
port
string ^\d{1,2}/\d{1,2}/\d{1,2}$

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/ipPorts/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/ipPorts/switch/{serialNumber}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    [
    ]
}

Lag

Lag APIs

Update Lag

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

id
string
name
string ^(?:(?!").){1,64}$
ports
Array of strings
taggedVlans
Array of strings
type
string
Enum: "static" "dynamic"
untaggedVlan
string

Responses

200

OK

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

put/api/switch/tenant/{tenantId}/lag
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/lag

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "ports":
    [
    ],
  • "taggedVlans":
    [
    ],
  • "type": "static",
  • "untaggedVlan": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete Lags

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
string

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/lag
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/lag

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get Lags By Serial Number

List of Switch's Lag settings

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/lag/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/lag/switch/{serialNumber}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Add Lag

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

id
string
name
string ^(?:(?!").){1,64}$
ports
Array of strings
taggedVlans
Array of strings
type
string
Enum: "static" "dynamic"
untaggedVlan
string

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/lag/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/lag/switch/{serialNumber}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "ports":
    [
    ],
  • "taggedVlans":
    [
    ],
  • "type": "static",
  • "untaggedVlan": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Lag

path Parameters
lagId
required
string

lagId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/lag/{lagId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/lag/{lagId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "ports":
    [
    ],
  • "taggedVlans":
    [
    ],
  • "type": "static",
  • "untaggedVlan": "string"
}

Delete Lag

path Parameters
lagId
required
string

lagId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/lag/{lagId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/lag/{lagId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Add Lags

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
id
string
name
string ^(?:(?!").){1,64}$
ports
Array of strings
taggedVlans
Array of strings
type
string
Enum: "static" "dynamic"
untaggedVlan
string

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/lags/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/lags/switch/{serialNumber}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    [
    ]
}

Port

Port APIs

Get Ports By Serial Number

List of Switch's port settings

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/port/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/port/switch/{serialNumber}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Update Port

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

dhcpSnoopingTrust
boolean

default: false

egressAcl
string
id
string
ignoreFields
string
ingressAcl
string
ipsg
boolean

default: false

lag
object (Lag)

domina object representing LAG Model

lldpEnable
boolean

default: true

name
string
poeBudget
number <float> [ 0 .. 30 ]
poeCapability
boolean

default: true

poeClass
string
Enum: "UNSET" "ZERO" "ONE" "TWO" "THREE" "FOUR"
poeEnable
boolean

default: true

poePriority
integer <int32>
port
required
string ^\d{1,2}/\d{1,2}/\d{1,2}$
portEnable
boolean

default: true

portProtected
boolean

default: false

portSpeed
string
Enum: "UNSET" "NONE" "AUTO" "TEN_M_FULL" "TEN_M_HALF" "ONE_HUNDRED_M_FULL" "ONE_HUNDRED_M_HALF" "ONE_G_FULL" "ONE_G_FULL_MASTER" "ONE_G_FULL_SLAVE" "TWO_POINT_FIVE_G_FULL" "TWO_POINT_FIVE_G_FULL_MASTER" "TWO_POINT_FIVE_G_FULL_SLAVE" "FIVE_G_FULL" "FIVE_G_FULL_MASTER" "FIVE_G_FULL_SLAVE" "TEN_G_FULL" "TEN_G_FULL_MASTER" "TEN_G_FULL_SLAVE" "TWENTY_FIVE_G_FULL" "FORTY_G_FULL" "ONE_HUNDRED_G_FULL"
ports
Array of strings
revert
boolean

default: false

rstpAdminEdgePort
boolean

default: false

stpBpduGuard
boolean

default: false

stpRootGuard
boolean

default: false

taggedVlans
Array of strings
tags
string
untaggedVlan
string

Responses

200

OK

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

put/api/switch/tenant/{tenantId}/port/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/port/switch/{serialNumber}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dhcpSnoopingTrust": true,
  • "egressAcl": "string",
  • "id": "string",
  • "ignoreFields": "string",
  • "ingressAcl": "string",
  • "ipsg": true,
  • "lag":
    {
    },
  • "lldpEnable": true,
  • "name": "string",
  • "poeBudget": 0,
  • "poeCapability": true,
  • "poeClass": "UNSET",
  • "poeEnable": true,
  • "poePriority": 0,
  • "port": "string",
  • "portEnable": true,
  • "portProtected": true,
  • "portSpeed": "UNSET",
  • "ports":
    [
    ],
  • "revert": true,
  • "rstpAdminEdgePort": true,
  • "stpBpduGuard": true,
  • "stpRootGuard": true,
  • "taggedVlans":
    [
    ],
  • "tags": "string",
  • "untaggedVlan": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get Port

path Parameters
portNum
required
integer <int32>

portNum

serialNumber
required
string

serialNumber

slotNum
required
integer <int32>

slotNum

tenantId
required
string

ALTO Tenant ID

unitNum
required
integer <int32>

unitNum

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/port/switch/{serialNumber}/portId/{unitNum}/{slotNum}/{portNum}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/port/switch/{serialNumber}/portId/{unitNum}/{slotNum}/{portNum}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dhcpSnoopingTrust": true,
  • "egressAcl": "string",
  • "id": "string",
  • "ignoreFields": "string",
  • "ingressAcl": "string",
  • "ipsg": true,
  • "lag":
    {
    },
  • "lldpEnable": true,
  • "name": "string",
  • "poeBudget": 0,
  • "poeCapability": true,
  • "poeClass": "UNSET",
  • "poeEnable": true,
  • "poePriority": 0,
  • "port": "string",
  • "portEnable": true,
  • "portProtected": true,
  • "portSpeed": "UNSET",
  • "ports":
    [
    ],
  • "revert": true,
  • "rstpAdminEdgePort": true,
  • "stpBpduGuard": true,
  • "stpRootGuard": true,
  • "taggedVlans":
    [
    ],
  • "tags": "string",
  • "untaggedVlan": "string"
}

Get Ports

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
string

Responses

200

OK

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/switch/tenant/{tenantId}/port/switch/{serialNumber}/ports
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/port/switch/{serialNumber}/ports

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    [
    ]
}

Profile

Profile APIs

Add Profile

Add Profile

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

acls
Array of objects (Acl)

default: new HashSet()

description
string
id
string
name
required
string (?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$
trustedPorts
Array of objects (TrustedPort)

default: new HashSet()

venues
Array of strings
vlans
Array of objects (Vlan)

default: new HashSet()

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/profile
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "acls":
    [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "trustedPorts":
    [
    ],
  • "venues":
    [
    ],
  • "vlans":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Update Profile

Update Profile

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

acls
Array of objects (Acl)

default: new HashSet()

description
string
id
string
name
required
string (?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$
trustedPorts
Array of objects (TrustedPort)

default: new HashSet()

venues
Array of strings
vlans
Array of objects (Vlan)

default: new HashSet()

Responses

200

OK

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

put/api/switch/tenant/{tenantId}/profile
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "acls":
    [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "trustedPorts":
    [
    ],
  • "venues":
    [
    ],
  • "vlans":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Profile

Profile

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profile/{profileId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "acls":
    [
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "trustedPorts":
    [
    ],
  • "venues":
    [
    ],
  • "vlans":
    [
    ]
}

Delete Profile

Delete Profile

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/profile/{profileId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get Profiles

List of tenant's profiles

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profiles
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profiles

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Delete Profiles

Delete Profile

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
string

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/profiles
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profiles

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get Profiles By Venue

List of tenant's profiles by Venue Id

path Parameters
tenantId
required
string

ALTO Tenant ID

venueId
required
string

venueId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profiles/venue/{venueId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profiles/venue/{venueId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

RoutedInterface

RoutedInterface APIs

Delete Routed Interfaces

Delete a List of IpPortId and VePortId

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
string

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/routedinterface
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/routedinterface

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Delete Routed Interfaces By Switch

Delete a List of IpPortId and VePortId

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
string

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/routedinterface/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/routedinterface/switch/{serialNumber}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

StackMembers

StackMembers APIs

Get Stack Members

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/stack/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/stack/switch/{serialNumber}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Add Stack Member

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

id
required
string ^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK|FEL|FJN|FJP|FMD|FME|FMF|FMG|FMU|FMH|FMJ|EZC|EZD|EZE|FLU|FLV|FLW|FLX)([0-9A-Z]{2})(0[1-9]|[1-4][0-9]|5[0-4])([A-HJ-NP-Z])([0-9A-HJ-NPRSTV-Z]{3})$

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/stack/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/stack/switch/{serialNumber}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Delete Stack Member

path Parameters
stackSwitchSerialNumber
required
string

stackSwitchSerialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/stack/{stackSwitchSerialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/stack/{stackSwitchSerialNumber}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

StaticRoute

StaticRoute APIs

Update Static Route

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

adminDistance
integer <int32> [ 1 .. 255 ]
destinationIp
string ^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\/([1-9]|[12]\d|3[0-2])$
id
string
nextHop
string ^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)$

Responses

200

OK

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

put/api/switch/tenant/{tenantId}/staticRoute
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/staticRoute

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "adminDistance": 1,
  • "destinationIp": "string",
  • "id": "string",
  • "nextHop": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Static Routes By Serial Number

List of Switch's StaticRoute settings

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/staticRoute/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/staticRoute/switch/{serialNumber}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Add Static Route

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

adminDistance
integer <int32> [ 1 .. 255 ]
destinationIp
string ^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\/([1-9]|[12]\d|3[0-2])$
id
string
nextHop
string ^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)$

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/staticRoute/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/staticRoute/switch/{serialNumber}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "adminDistance": 1,
  • "destinationIp": "string",
  • "id": "string",
  • "nextHop": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Static Route

path Parameters
staticRouteId
required
string

staticRouteId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/staticRoute/{staticRouteId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/staticRoute/{staticRouteId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "adminDistance": 1,
  • "destinationIp": "string",
  • "id": "string",
  • "nextHop": "string"
}

Delete Static Route

path Parameters
staticRouteId
required
string

staticRouteId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/staticRoute/{staticRouteId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/staticRoute/{staticRouteId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Delete Static Routes

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
string

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/staticRoutes
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/staticRoutes

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Add Static Routes

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
adminDistance
integer <int32> [ 1 .. 255 ]
destinationIp
string ^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\/([1-9]|[12]\d|3[0-2])$
id
string
nextHop
string ^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)\.(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\b)$

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/staticRoutes/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/staticRoutes/switch/{serialNumber}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    [
    ]
}

TrustedPort

TrustedPort APIs

Get Trusted Ports By Venue

List of TrustedPort under a venue

path Parameters
tenantId
required
string

ALTO Tenant ID

venueId
required
string

venueId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profile/trustedPorts/venue/{venueId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/trustedPorts/venue/{venueId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Add Trusted Port

Add TrustedPort

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

id
string
model
string
Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C"
trustPorts
Array of strings
trustedPortType
string
Enum: "all" "dhcp" "arp"

default: TrustedPortTypeEnum.all

vlanDemand
boolean

default: false

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/profile/{profileId}/trustedPort
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/trustedPort

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "model": "ICX7150-24",
  • "trustPorts":
    [
    ],
  • "trustedPortType": "all",
  • "vlanDemand": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Update Trusted Port

Update TrustedPort

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

id
string
model
string
Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C"
trustPorts
Array of strings
trustedPortType
string
Enum: "all" "dhcp" "arp"

default: TrustedPortTypeEnum.all

vlanDemand
boolean

default: false

Responses

200

OK

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

put/api/switch/tenant/{tenantId}/profile/{profileId}/trustedPort
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/trustedPort

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "model": "ICX7150-24",
  • "trustPorts":
    [
    ],
  • "trustedPortType": "all",
  • "vlanDemand": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Trusted Port

Get TrustedPort

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

trustedPortId
required
string

trustedPortId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profile/{profileId}/trustedPort/{trustedPortId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/trustedPort/{trustedPortId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "model": "ICX7150-24",
  • "trustPorts":
    [
    ],
  • "trustedPortType": "all",
  • "vlanDemand": true
}

Delete Trusted Port

Delete TrustedPort

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

trustedPortId
required
string

trustedPortId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/profile/{profileId}/trustedPort/{trustedPortId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/trustedPort/{trustedPortId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

VePort

VePort APIs

Update Ve Port

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

dhcpRelayAgent
string
egressAcl
string
id
string
ingressAcl
string
ipAddress
string
ipSubnetMask
string
name
string
ospfArea
string
vlanId
integer <int32>

Responses

200

OK

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

put/api/switch/tenant/{tenantId}/vePort
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/vePort

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dhcpRelayAgent": "string",
  • "egressAcl": "string",
  • "id": "string",
  • "ingressAcl": "string",
  • "ipAddress": "string",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "vlanId": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Ve Ports By Serial Number

List of Switch's VePort settings

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/vePort/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/vePort/switch/{serialNumber}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Add Ve Port

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

dhcpRelayAgent
string
egressAcl
string
id
string
ingressAcl
string
ipAddress
string
ipSubnetMask
string
name
string
ospfArea
string
vlanId
integer <int32>

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/vePort/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/vePort/switch/{serialNumber}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dhcpRelayAgent": "string",
  • "egressAcl": "string",
  • "id": "string",
  • "ingressAcl": "string",
  • "ipAddress": "string",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "vlanId": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Ve Port

path Parameters
tenantId
required
string

ALTO Tenant ID

vePortId
required
string

vePortId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/vePort/{vePortId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/vePort/{vePortId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dhcpRelayAgent": "string",
  • "egressAcl": "string",
  • "id": "string",
  • "ingressAcl": "string",
  • "ipAddress": "string",
  • "ipSubnetMask": "string",
  • "name": "string",
  • "ospfArea": "string",
  • "vlanId": 0
}

Delete Ve Port

path Parameters
tenantId
required
string

ALTO Tenant ID

vePortId
required
string

vePortId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/vePort/{vePortId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/vePort/{vePortId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Delete Ve Ports

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
string

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/vePorts
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/vePorts

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Add Ve Ports

path Parameters
serialNumber
required
string

serialNumber

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
dhcpRelayAgent
string
egressAcl
string
id
string
ingressAcl
string
ipAddress
string
ipSubnetMask
string
name
string
ospfArea
string
vlanId
integer <int32>

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/vePorts/switch/{serialNumber}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/vePorts/switch/{serialNumber}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    [
    ]
}

Venue

Venue APIs

Update Venue

path Parameters
tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

dns
Array of strings
firmware
string
id
string
name
string
profileId
string
switchLoginPassword
string
switchLoginUsername
string
syslogEnabled
boolean

default: false

syslogPrimaryServer
string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(([a-zA-Z]{1})|([a-zA-Z]{1}[a-zA-Z]{1})|([a-zA-Z]{1}[0-9]{1})|([0-9]{1}[a-zA-Z]{1})|([a-zA-Z0-9][a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]))\.([a-zA-Z]{2,6}|[a-zA-Z0-9-]{2,30}\.[a-zA-Z]{2,3})$)
syslogSecondaryServer
string (^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(([a-zA-Z]{1})|([a-zA-Z]{1}[a-zA-Z]{1})|([a-zA-Z]{1}[0-9]{1})|([0-9]{1}[a-zA-Z]{1})|([a-zA-Z0-9][a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]))\.([a-zA-Z]{2,6}|[a-zA-Z0-9-]{2,30}\.[a-zA-Z]{2,3})$)

Responses

200

OK

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

put/api/switch/tenant/{tenantId}/venue
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/venue

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dns":
    [
    ],
  • "firmware": "string",
  • "id": "string",
  • "name": "string",
  • "profileId": "string",
  • "switchLoginPassword": "string",
  • "switchLoginUsername": "string",
  • "syslogEnabled": true,
  • "syslogPrimaryServer": "string",
  • "syslogSecondaryServer": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Venue

path Parameters
tenantId
required
string

ALTO Tenant ID

venueId
required
string

venueId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/venue/{venueId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/venue/{venueId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dns":
    [
    ],
  • "firmware": "string",
  • "id": "string",
  • "name": "string",
  • "profileId": "string",
  • "switchLoginPassword": "string",
  • "switchLoginUsername": "string",
  • "syslogEnabled": true,
  • "syslogPrimaryServer": "string",
  • "syslogSecondaryServer": "string"
}

Vlan

Vlan APIs

Get Vlans By Venue

List of VLAN under a venue

path Parameters
tenantId
required
string

ALTO Tenant ID

venueId
required
string

venueId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profile/vlans/venue/{venueId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/vlans/venue/{venueId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Vlans By Venue And Model

List of VLAN under a venue with specific model

path Parameters
model
required
string

model

tenantId
required
string

ALTO Tenant ID

venueId
required
string

venueId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profile/vlans/venue/{venueId}/model/{model}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/vlans/venue/{venueId}/model/{model}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Tagged Vlans By Venue

List of VLAN under a venue with specific model and tagged port

path Parameters
model
required
string

model

slotId
required
integer <int32>

slotId

taggedPortId
required
integer <int32>

taggedPortId

tenantId
required
string

ALTO Tenant ID

unitId
required
integer <int32>

unitId

venueId
required
string

venueId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profile/vlans/venue/{venueId}/model/{model}/tagged/{unitId}/{slotId}/{taggedPortId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/vlans/venue/{venueId}/model/{model}/tagged/{unitId}/{slotId}/{taggedPortId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Untagged Vlans By Venue

List of VLAN under a venue with specific model and untagged port

path Parameters
model
required
string

model

slotId
required
integer <int32>

slotId

tenantId
required
string

ALTO Tenant ID

unitId
required
integer <int32>

unitId

untaggedPortId
required
integer <int32>

untaggedPortId

venueId
required
string

venueId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profile/vlans/venue/{venueId}/model/{model}/untagged/{unitId}/{slotId}/{untaggedPortId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/vlans/venue/{venueId}/model/{model}/untagged/{unitId}/{slotId}/{untaggedPortId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Add Vlan

Add Vlan

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

arpInspection
boolean

default: false

arpInspectionTrustPort
string
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
ipv4DhcpSnooping
boolean

default: false

ipv4DhcpSnoopingTrustPort
string
multicastVersion
integer <int32> [ 2 .. 3 ]
rootBridgeFamilyId
string
Enum: "ICX7150" "ICX7250" "ICX7650" "ICX7850"
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
spanningTreeProtocol
string
Enum: "rstp" "stp" "none"
switchFamilyModels
Array of objects (SwitchFamilyModel)

default: new HashSet()

vlanId
integer <int32> [ 2 .. 4094 ]
vlanName
string [ 0 .. 32 ] characters

Responses

200

OK

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

post/api/switch/tenant/{tenantId}/profile/{profileId}/vlan
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/vlan

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 2,
  • "rootBridgeFamilyId": "ICX7150",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels":
    [
    ],
  • "vlanId": 2,
  • "vlanName": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Update Vlan

Update Vlan

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

arpInspection
boolean

default: false

arpInspectionTrustPort
string
id
string
igmpSnooping
string
Enum: "active" "passive" "none"
ipv4DhcpSnooping
boolean

default: false

ipv4DhcpSnoopingTrustPort
string
multicastVersion
integer <int32> [ 2 .. 3 ]
rootBridgeFamilyId
string
Enum: "ICX7150" "ICX7250" "ICX7650" "ICX7850"
spanningTreePriority
integer <int32> [ 0 .. 65535 ]
spanningTreeProtocol
string
Enum: "rstp" "stp" "none"
switchFamilyModels
Array of objects (SwitchFamilyModel)

default: new HashSet()

vlanId
integer <int32> [ 2 .. 4094 ]
vlanName
string [ 0 .. 32 ] characters

Responses

200

OK

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

put/api/switch/tenant/{tenantId}/profile/{profileId}/vlan
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/vlan

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 2,
  • "rootBridgeFamilyId": "ICX7150",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels":
    [
    ],
  • "vlanId": 2,
  • "vlanName": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string",
  • "response":
    {
    }
}

Get Vlan

Vlan

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

vlanUuid
required
string

vlanUuid

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profile/{profileId}/vlan/{vlanUuid}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/vlan/{vlanUuid}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "arpInspection": true,
  • "arpInspectionTrustPort": "string",
  • "id": "string",
  • "igmpSnooping": "active",
  • "ipv4DhcpSnooping": true,
  • "ipv4DhcpSnoopingTrustPort": "string",
  • "multicastVersion": 2,
  • "rootBridgeFamilyId": "ICX7150",
  • "spanningTreePriority": 0,
  • "spanningTreeProtocol": "rstp",
  • "switchFamilyModels":
    [
    ],
  • "vlanId": 2,
  • "vlanName": "string"
}

Delete Vlan

Delete Vlan

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

vlanUuid
required
string

vlanUuid

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/profile/{profileId}/vlan/{vlanUuid}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/vlan/{vlanUuid}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get Vlans

List of VLAN under a profile

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

query Parameters
page
string

page

size
string

size

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/profile/{profileId}/vlans
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/vlans

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Delete Vlans

Delete Vlans

path Parameters
profileId
required
string

profileId

tenantId
required
string

ALTO Tenant ID

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Request Body schema: application/json

viewInput

Array
string

Responses

200

OK

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

delete/api/switch/tenant/{tenantId}/profile/{profileId}/vlans
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/profile/{profileId}/vlans

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "string"
}

Get Vlan Venue Id

path Parameters
tenantId
required
string

ALTO Tenant ID

venueId
required
string

venueId

vlanId
required
string

vlanId

header Parameters
x-request-id
required
string

Injected by API GW

x-rks-tenantid
required
string

ALTO Tenant ID, Injected by API GW

Responses

200

OK

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/switch/tenant/{tenantId}/vlan/{vlanId}/venue/{venueId}
https://altocloud.ruckuswireless.com/api/switch/tenant/{tenantId}/vlan/{vlanId}/venue/{venueId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "altoId": "string",
  • "szNameId": "string",
  • "venueId": "string"
}