AOS-CX

The AOS-CX Developer Hub

Welcome to the AOS-CX developer hub. You'll find comprehensive guides and documentation to help you start working with AOS-CX as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

The GET method is a read method that gets the resource specified by the URI. Data is returned in JSON format in the response body.

Example

The below example fetches configuration attributes for each VLAN with a depth=2 and selector=configuration

GET "https://192.0.2.5/rest/v1/system/vlans?depth=2&selector=configuration"

{
   "admin": "up",
   "id": 1,
   "mgmd_enable": {},
   "mgmd_igmp_block_ports": [],
   "mgmd_igmp_fastleave_ports": [],
   "mgmd_igmp_forcedfastleave_ports": [],
   "mgmd_igmp_forward_ports": [],
   "mgmd_igmp_static_groups": [],
   "mgmd_mld_block_ports": [],
   "mgmd_mld_fastleave_ports": [],
   "mgmd_mld_forcedfastleave_ports": [],
   "mgmd_mld_forward_ports": [],
   "mgmd_mld_static_groups": [],
   "name": "VLAN1",
   "type": "static"
},
{
   "admin": "up",
   "id": 10,
   "mgmd_enable": {},
   "mgmd_igmp_block_ports": [],
   "mgmd_igmp_fastleave_ports": [],
   "mgmd_igmp_forcedfastleave_ports": [],
   "mgmd_igmp_forward_ports": [],
   "mgmd_igmp_static_groups": [],
   "mgmd_mld_block_ports": [],
   "mgmd_mld_fastleave_ports": [],
   "mgmd_mld_forcedfastleave_ports": [],
   "mgmd_mld_forward_ports": [],
   "mgmd_mld_static_groups": [],
   "name": "VLAN10",
   "type": "static"
},
{
  "admin": "up",
  "id": 20,
  "mgmd_enable": {},
  "mgmd_igmp_block_ports": [],
  "mgmd_igmp_fastleave_ports": [],
  "mgmd_igmp_forcedfastleave_ports": [],
  "mgmd_igmp_forward_ports": [],
  "mgmd_igmp_static_groups": [],
  "mgmd_mld_block_ports": [],
  "mgmd_mld_fastleave_ports": [],
  "mgmd_mld_forcedfastleave_ports": [],
  "mgmd_mld_forward_ports": [],
  "mgmd_mld_static_groups": [],
  "name": "VLAN20",
  "type": "static"
}

Updated 9 days ago


What's Next

POST

GET


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.