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"
}

What’s Next
Did this page help you?