Jump to Content

Home Guides API Reference

Guides API Reference GitHub Airheads Developer Community Log In

API Reference

Guides API Reference GitHub Airheads Developer Community Log In

AOS-CX REST API

AAA_Accounting_Attributes
AAA_Server_Group
AAA_Server_Group_Prio
AAA_Test_Server
AAA_Test_Server_Status
- /system/aaa_test_server_statusesget
ACL
ACL_Entry
ACL_Object_Group
Aggregate_address
Authentication_Modes
- Get the status of the https-server authentication modes.get
BFD_Session
- /system/vrfs/{VRF.name}/bfd_sessionsget
- /system/vrfs/{VRF.name}/bfd_sessions/{BFD_Session.from},{BFD_Session.from_instance_id},{BFD_Session.operating_mode},{BFD_Session.dst_ip},{BFD_Session.src_port}get
BGP_ASPath_Filter
BGP_ASPath_Filter_Entry
BGP_Community_Filter
BGP_Community_Filter_Entry
BGP_Neighbor
BGP_Route
- /system/vrfs/{VRF.name}/bgp_routesget
- /system/vrfs/{VRF.name}/bgp_routes/{BGP_Route.prefix},{BGP_Route.peer},{BGP_Route.vni},{BGP_Route.path_id}get
BGP_Router
BGP_Update_Group
- /system/bgp_update_groupsget
- /system/bgp_update_groups/{BGP_Update_Group.vrf},{BGP_Update_Group.group_id}get
BGP_VPNv4_Route
- /system/vrfs/{VRF.name}/bgp_routes/{BGP_Route.prefix},{BGP_Route.peer},{BGP_Route.vni},{BGP_Route.path_id}/vpnv4_routesget
- /system/vrfs/{VRF.name}/bgp_routes/{BGP_Route.prefix},{BGP_Route.peer},{BGP_Route.vni},{BGP_Route.path_id}/vpnv4_routes/{BGP_VPNv4_Route.label},{BGP_VPNv4_Route.rd}get
Boot
- Reboot the specified firmware image(s).post
Button
- /system/subsystems/{Subsystem.type},{Subsystem.name}/buttonsget
- /system/subsystems/{Subsystem.type},{Subsystem.name}/buttons/{Button.name}get
Captive_Portal_Profile
CDP_Neighbor
- /system/interfaces/{Interface.name}/cdp_neighborsget
- /system/interfaces/{Interface.name}/cdp_neighbors/{CDP_Neighbor.mac_addr}get
Certificate_Login
- Certificate based authentication.post
CertificateManager
Class
Class_Entry
Clear_OSPF_neighbor
CLI
- Execute troubleshooting CLI show commandpost
- Retrieve a list of allowed CLI commandsget
CLI_Alias
Client_Insight
- /system/client_insightsget
- /system/client_insights/{Client_Insight.mac}get
Client_Insight_Per_VLAN
- /system/client_insights/{Client_Insight.mac}/per_vlan_client_insightget
- /system/client_insights/{Client_Insight.mac}/per_vlan_client_insight/{VLAN.vlan}get
Config_Operation
- /system/config_operationsget
- /system/config_operations/{Config_Operation.requester},{Config_Operation.requester_index},{Config_Operation.operation_index}get
Configuration
Container
Container_Manifest
- /system/containers/{Container.name}/manifestget
Container_Network
CoPP_Policy
CoPP_Policy_Entry
Daemon
- /system/subsystems/{Subsystem.type},{Subsystem.name}/daemonsget
- /system/subsystems/{Subsystem.type},{Subsystem.name}/daemons/{Daemon.name}get
Data_Plane
- /system/subsystems/{Subsystem.type},{Subsystem.name}/data_planesget
- /system/subsystems/{Subsystem.type},{Subsystem.name}/data_planes/{Data_Plane.id}get
DB_Observer_Rules
Device_Profile
DHCP_Lease
- /system/vrfs/{VRF.name}/dhcp_leasesget
- /system/vrfs/{VRF.name}/dhcp_leases/{DHCP_Lease.ip_address}get
DHCP_Relay
DHCP_Relay_V6_Mcast_Server
DHCP_Server
DHCP_Server_Option
DHCP_Server_Pool
DHCP_Server_Range
DHCP_Server_Static_Host
DHCPv4_Snooping_Guard_Policy
DHCPV6_Server
DHCPV6_Server_Option
DHCPV6_Server_Pool
DHCPV6_Server_Range
DHCPV6_Server_Static_Host
DHCPv6_Snooping_Guard_Policy
Diag_Test_Result
- /system/subsystems/{Subsystem.type},{Subsystem.name}/diag_test_resultsget
- /system/subsystems/{Subsystem.type},{Subsystem.name}/diag_test_results/{Diag_Test_Result.mgmt_module},{Diag_Test_Result.name}get
DLog
Dot1X_Supplicant_Policy
Download
- /system/downloadsget
- /system/downloads/{Download.transfer_num}get
EVPN
EVPN_Instance
- /system/evpn_instancesget
- /system/evpn_instances/{EVPN_Instance.evi}get
EVPN_MAC_IP
- /system/evpn_mac_ipsget
- /system/evpn_mac_ips/{EVPN_MAC_IP.evi},{EVPN_MAC_IP.mac_address},{EVPN_MAC_IP.ip_address},{EVPN_MAC_IP.nexthop}get
EVPN_VLAN
EVPN_VLAN_Aware_Bundle
EVPN_VTEP_Neighbor
- /system/vrfs/{VRF.name}/evpn_vtep_neighborsget
- /system/vrfs/{VRF.name}/evpn_vtep_neighbors/{EVPN_VTEP_Neighbor.ip_address}get
External_Storage
Fan
- /system/subsystems/{Subsystem.type},{Subsystem.name}/fansget
- /system/subsystems/{Subsystem.type},{Subsystem.name}/fans/{Fan.name}get
Firmware
Hot_Patch
HPE_ANW_Central
HSC
Interface
IP6_Address
IP_Binding
- /system/ip_bindingsget
- /system/ip_bindings/{IP_Binding.vlan},{IP_Binding.ip_address}get
IPsec_SA
- /system/vrfs/{VRF.name}/ipsec_sasget
- /system/vrfs/{VRF.name}/ipsec_sas/{IPsec_SA.SPI},{IPsec_SA.ipsec_protocol},{IPsec_SA.address_family},{IPsec_SA.dest_ip},{IPsec_SA.direction}get
IPsec_SP
- /system/vrfs/{VRF.name}/ipsec_spsget
ipsla_responder
ipsla_responder_statistics
- /system/ipsla_responders/{ipsla_responder.name}/ipsla_responder_statisticsget
- /system/ipsla_responders/{ipsla_responder.name}/ipsla_responder_statistics/{ipsla_responder_statistics.source_ip},{ipsla_responder_statistics.source_port},{ipsla_responder_statistics.vrf}get
ipsla_source
IPv6_Destination_Guard_Policy
IVRL_Neighbor
- /system/vrfs/{VRF.name}/ivrl_neighborsget
- /system/vrfs/{VRF.name}/ivrl_neighbors/{IVRL_Neighbor.ip_address},{IVRL_Neighbor.port}get
Job
Job_Entry
Key
Keychain
L2_Composite_Group
- /system/l2_composite_groupsget
- /system/l2_composite_groups/{L2_Composite_Group.id}get
L2_Destination
- /system/l2_destinationsget
- /system/l2_destinations/{L2_Destination.id},{L2_Destination.l2_destination_type}get
L3_Composite_Group
- /system/l3_composite_groupsget
- /system/l3_composite_groups/{L3_Composite_Group.id}get
L3_Destination
- /system/l3_destinationsget
- /system/l3_destinations/{L3_Destination.forwarding_type},{L3_Destination.id}get
Label_Endpoint
Label_Switch
Label_Switch_Path
- /system/label_switch_pathsget
- /system/label_switch_paths/{Label_Switch_Path.out_label},{Label_Switch_Path.nexthop_ip},{Label_Switch_Path.type}get
LED
LLDP_Neighbor
- /system/interfaces/{Interface.name}/lldp_neighborsget
- /system/interfaces/{Interface.name}/lldp_neighbors/{LLDP_Neighbor.chassis_id},{LLDP_Neighbor.port_id}get
Logging_Filter
Logging_Filter_Entry
Login
- User login.post
Logout
- User logout.post
Logs
LSP_ECMP_Group
- /system/lsp_ecmp_groupsget
- /system/lsp_ecmp_groups/{LSP_ECMP_Group.label_switch_path_group_id}get
MAC
- /system/vlans/{VLAN.id}/macsget
- /system/vlans/{VLAN.id}/macs/{MAC.from},{MAC.mac_addr}get
MAC_Group
MAC_Group_Entry
MAC_Lockout
MAC_Statistics
- /system/mac_statisticsget
- /system/mac_statistics/{MAC_Statistics.vlan},{MAC_Statistics.mac_addr}get
MACsec_KaY_MKA
- /system/interfaces/{Interface.name}/macsec_secies/{MACsec_SecY.id}/kay_mkaget
- /system/interfaces/{Interface.name}/macsec_secies/{MACsec_SecY.id}/kay_mka/{MACsec_KaY_MKA.id}get
MACsec_KaY_MKA_Participant
- /system/interfaces/{Interface.name}/macsec_secies/{MACsec_SecY.id}/kay_mka/{MACsec_KaY_MKA.id}/participantsget
- /system/interfaces/{Interface.name}/macsec_secies/{MACsec_SecY.id}/kay_mka/{MACsec_KaY_MKA.id}/participants/{MACsec_KaY_MKA_Participant.ckn}get
MACsec_KaY_MKA_Peer
- /system/interfaces/{Interface.name}/macsec_secies/{MACsec_SecY.id}/kay_mka/{MACsec_KaY_MKA.id}/participants/{MACsec_KaY_MKA_Participant.ckn}/peersget
- /system/interfaces/{Interface.name}/macsec_secies/{MACsec_SecY.id}/kay_mka/{MACsec_KaY_MKA.id}/participants/{MACsec_KaY_MKA_Participant.ckn}/peers/{MACsec_KaY_MKA_Peer.member_identifier}get
MACsec_Policy
MACsec_Secure_Association
- /system/macsec_secure_channels/{MACsec_Secure_Channel.sci},{MACsec_Secure_Channel.channel_type}/secure_associationsget
- /system/macsec_secure_channels/{MACsec_Secure_Channel.sci},{MACsec_Secure_Channel.channel_type}/secure_associations/{MACsec_Secure_Association.secure_association_number}get
MACsec_Secure_Channel
- /system/macsec_secure_channelsget
- /system/macsec_secure_channels/{MACsec_Secure_Channel.sci},{MACsec_Secure_Channel.channel_type}get
MACsec_SecY
- /system/interfaces/{Interface.name}/macsec_seciesget
- /system/interfaces/{Interface.name}/macsec_secies/{MACsec_SecY.id}get
MGMD_PGS
- /system/interfaces/{Interface.name}/mgmd_pgsget
- /system/interfaces/{Interface.name}/mgmd_pgs/{MGMD_PGS.mgmd_type},{MGMD_PGS.group_ip},{MGMD_PGS.source_ip}get
MGMD_VGPS
- /system/vlans/{VLAN.id}/mgmd_vgs/{MGMD_VGS.mgmd_type},{MGMD_VGS.group_ip},{MGMD_VGS.source_ip},{MGMD_VGS.filter_type}/vgps_entriesget
- /system/vlans/{VLAN.id}/mgmd_vgs/{MGMD_VGS.mgmd_type},{MGMD_VGS.group_ip},{MGMD_VGS.source_ip},{MGMD_VGS.filter_type}/vgps_entries/{Interface.port}get
MGMD_VGPS_DEBUG
- /system/mgmd_vgps_debugsget
- /system/mgmd_vgps_debugs/{MGMD_VGPS_DEBUG.vlan},{MGMD_VGPS_DEBUG.group_ip},{MGMD_VGPS_DEBUG.port},{MGMD_VGPS_DEBUG.source_ip}get
MGMD_VGS
- /system/vlans/{VLAN.id}/mgmd_vgsget
- /system/vlans/{VLAN.id}/mgmd_vgs/{MGMD_VGS.mgmd_type},{MGMD_VGS.group_ip},{MGMD_VGS.source_ip},{MGMD_VGS.filter_type}get
Mirror
MKA_Policy
MPLS_Global
MPLS_LDP
MPLS_LDP_Bindings_Local
- /system/mpls_ldp_bindings_localsget
- /system/mpls_ldp_bindings_locals/{MPLS_LDP_Bindings_Local.prefix}get
MPLS_LDP_Discovery
- /system/mpls_ldp_discoveriesget
- /system/mpls_ldp_discoveries/{MPLS_LDP_Discovery.router_id},{MPLS_LDP_Discovery.peer_router_id},{MPLS_LDP_Discovery.out_port}get
MPLS_LDP_Neighbor
- /system/mpls_ldp_neighborsget
- /system/mpls_ldp_neighbors/{MPLS_LDP_Neighbor.router_id},{MPLS_LDP_Neighbor.peer_router_id}get
MPLS_OAM
MPLS_OAM_Downstream_Responses
- /system/mpls_oams/{MPLS_OAM.request_timestamp},{MPLS_OAM.target_address}/downstream_responsesget
- /system/mpls_oams/{MPLS_OAM.request_timestamp},{MPLS_OAM.target_address}/downstream_responses/{MPLS_OAM_Downstream_Responses.sequence_id},{MPLS_OAM_Downstream_Responses.downstream_interface_address}get
MPLS_Static_LSP
MPLS_Static_LSP_Binding
MSDP_Peer
MSDP_Router
MSDP_SA_Cache
- /system/vrfs/{VRF.name}/msdp_router/msdp_peers/{MSDP_Peer.address}/msdp_sa_cachesget
- /system/vrfs/{VRF.name}/msdp_router/msdp_peers/{MSDP_Peer.address}/msdp_sa_caches/{MSDP_SA_Cache.source_address},{MSDP_SA_Cache.group_address},{MSDP_SA_Cache.rp_address}get
MTrace
- /system/mtracesget
- /system/mtraces/{MTrace.source_address},{MTrace.group_address},{MTrace.vrf},{MTrace.timestamp}get
Multicast_L3_Bridge_Control_Forwarding
- /system/vrfs/{VRF.name}/multicast_l3_bridge_control_forwardingsget
- /system/vrfs/{VRF.name}/multicast_l3_bridge_control_forwardings/{Multicast_L3_Bridge_Control_Forwarding.source_prefix},{Multicast_L3_Bridge_Control_Forwarding.destination_prefix},{Multicast_L3_Bridge_Control_Forwarding.VLAN}get
Multicast_L3_Forwarding
- /system/vrfs/{VRF.name}/multicast_l3_forwardingsget
- /system/vrfs/{VRF.name}/multicast_l3_forwardings/{Multicast_L3_Forwarding.source_prefix},{Multicast_L3_Forwarding.destination_prefix},{Multicast_L3_Forwarding.upstream_port}get
Multicast_L3_Neighbor_Forwarding
- /system/interfaces/{Interface.name}/multicast_l3_neighbor_forwardingsget
- /system/interfaces/{Interface.name}/multicast_l3_neighbor_forwardings/{Multicast_L3_Neighbor_Forwarding.from},{Multicast_L3_Neighbor_Forwarding.destination_address}get
Multicast_Operational_Static_Nexthop
- /system/multicast_operational_static_routes/{Multicast_Operational_Static_Route.port},{Multicast_Operational_Static_Route.source_address},{Multicast_Operational_Static_Route.group_address}/mcast_nexthopsget
- /system/multicast_operational_static_routes/{Multicast_Operational_Static_Route.port},{Multicast_Operational_Static_Route.source_address},{Multicast_Operational_Static_Route.group_address}/mcast_nexthops/{Multicast_Operational_Static_Nexthop.uuid}get
Multicast_Operational_Static_Route
- /system/multicast_operational_static_routesget
- /system/multicast_operational_static_routes/{Multicast_Operational_Static_Route.port},{Multicast_Operational_Static_Route.source_address},{Multicast_Operational_Static_Route.group_address}get
Multicast_Replication_Portset
- /system/multicast_replication_portsetsget
MVRP_VLAN
- /system/interfaces/{Interface.name}/mvrp_vlansget
- /system/interfaces/{Interface.name}/mvrp_vlans/{MVRP_VLAN.vlan-id}get
NAE
- Delete/Clear Time Series and Alerts Datadelete
NAE_Action
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_rules/{NAE_Rule.name}/nae_conditions/{NAE_Condition.condition_type}/actionsget
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_rules/{NAE_Rule.name}/nae_conditions/{NAE_Condition.condition_type}/actions/{NAE_Action.name}get
NAE_Action_Result
- Get the full NAE Action resultget
- Get the NAE Action resultget
NAE_Agent
NAE_Baseline
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_baselinesget
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_baselines/{NAE_Baseline.name}get
NAE_Condition
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_rules/{NAE_Rule.name}/nae_conditionsget
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_rules/{NAE_Rule.name}/nae_conditions/{NAE_Condition.condition_type}get
NAE_Condition_Event
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_rules/{NAE_Rule.name}/nae_conditions/{NAE_Condition.condition_type}/nae_condition_eventsget
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_rules/{NAE_Rule.name}/nae_conditions/{NAE_Condition.condition_type}/nae_condition_events/{NAE_Condition_Event.name}get
NAE_Graph
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_graphsget
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_graphs/{NAE_Graph.name}get
NAE_Monitor
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_monitorsget
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_monitors/{NAE_Monitor.name}get
NAE_Parameter
- /system/nae_scripts/{NAE_Script.name}/nae_parametersget
- /system/nae_scripts/{NAE_Script.name}/nae_parameters/{NAE_Parameter.name}get
NAE_Rule
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_rulesget
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_rules/{NAE_Rule.name}get
NAE_Script
NAE_Script_Condition
NAE_Script_Generate
NAE_Watch
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_watchesget
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_watches/{NAE_Watch.name}get
Neighbor
- /system/vrfs/{VRF.name}/neighborsget
- /system/vrfs/{VRF.name}/neighbors/{Neighbor.ip_address},{Neighbor.port}get
Nexthop
- /system/nexthopsget
- /system/nexthops/{Nexthop.id}get
Notification_Subscriber
- /system/notification_subscribersget
- /system/notification_subscribers/{Notification_Subscriber.name}get
Notification_Subscription
- /system/notification_subscribers/{Notification_Subscriber.name}/notification_subscriptionsget
- /system/notification_subscribers/{Notification_Subscriber.name}/notification_subscriptions/{Notification_Subscription.name}get
NTP_Association
NTP_Conductor
NTP_Key
OSPF_Area
OSPF_Interface
OSPF_LSA
OSPF_Neighbor
OSPF_Route
OSPF_Router
OSPF_Summary_Address
OSPF_Vlink
OSPFv3_AF_Router
OSPFv3_LSA
PBR_Action_List
PBR_Action_List_Entry
PIM_Clear_Mroute_Request
PIM_DFE
- /system/pim_dvesget
- /system/pim_dves/{PIM_DFE.port},{PIM_DFE.rp_address}get
PIM_Group_Mapping
- /system/vrfs/{VRF.name}/pim_routers/{PIM_Router.ip_version}/pim_group_mappingsget
- /system/vrfs/{VRF.name}/pim_routers/{PIM_Router.ip_version}/pim_group_mappings/{PIM_Group_Mapping.group_prefix},{PIM_Group_Mapping.rp_address}get
PIM_Join
- /system/pim_joinsget
- /system/pim_joins/{PIM_Join.pim_router},{PIM_Join.group_address},{PIM_Join.source_address},{PIM_Join.type}get
PIM_Local_Group_Source
- /system/vrfs/{VRF.name}/pim_routers/{PIM_Router.ip_version}/pim_local_group_sourcesget
- /system/vrfs/{VRF.name}/pim_routers/{PIM_Router.ip_version}/pim_local_group_sources/{PIM_Local_Group_Source.source_address},{PIM_Local_Group_Source.group_address},{PIM_Local_Group_Source.rp_address}get
PIM_Mroute
- /system/interfaces/{Interface.name}/pim_mroutesget
- /system/interfaces/{Interface.name}/pim_mroutes/{PIM_Mroute.source_address},{PIM_Mroute.group_address}get
PIM_Mroute_Exception
- /system/pim_mroute_exceptionsget
- /system/pim_mroute_exceptions/{PIM_Mroute_Exception.port},{PIM_Mroute_Exception.source_address},{PIM_Mroute_Exception.group_address}get
PIM_Neighbor
- /system/interfaces/{Interface.name}/pim_neighborsget
- /system/interfaces/{Interface.name}/pim_neighbors/{PIM_Neighbor.address}get
PIM_Nexthop
- /system/interfaces/{Interface.name}/pim_mroutes/{PIM_Mroute.source_address},{PIM_Mroute.group_address}/pim_nexthopsget
- /system/interfaces/{Interface.name}/pim_mroutes/{PIM_Mroute.source_address},{PIM_Mroute.group_address}/pim_nexthops/{PIM_Nexthop.uuid}get
PIM_Resultant_Group_Mapping
- /system/pim_resultant_group_mappingsget
- /system/pim_resultant_group_mappings/{PIM_Resultant_Group_Mapping.pim_router},{PIM_Resultant_Group_Mapping.group_address},{PIM_Resultant_Group_Mapping.rp_address}get
PIM_Router
PIM_RPF
- /system/pim_rpfsget
- /system/pim_rpfs/{PIM_RPF.vrf},{PIM_RPF.address},{PIM_RPF.group_address}get
PIM_Static_RP
Ping
- Ping result.get
PKI_EST_Profile
PKI_TA_Profile
PKI_X509_Certificate
Plugin
- /system/subsystems/{Subsystem.type},{Subsystem.name}/daemons/{Daemon.name}/pluginsget
- /system/subsystems/{Subsystem.type},{Subsystem.name}/daemons/{Daemon.name}/plugins/{Plugin.name}get
PoE_Interface
Policy
Policy_Action_Set
Policy_Entry
Port_Access_Auth_Configuration
Port_Access_Cached_Client
- /system/port_access_cached_clientsget
- /system/port_access_cached_clients/{Port_Access_Cached_Client.mac}get
Port_Access_CDP_Group
Port_Access_CDP_Group_Entry
Port_Access_Client
- /system/interfaces/{Interface.name}/port_access_clientsget
- /system/interfaces/{Interface.name}/port_access_clients/{Port_Access_Client.mac}get
Port_Access_Client_Auth_Attribute
- /system/interfaces/{Interface.name}/port_access_clients/{Port_Access_Client.mac}/auth_attributesget
- /system/interfaces/{Interface.name}/port_access_clients/{Port_Access_Client.mac}/auth_attributes/{Port_Access_Client_Auth_Attribute.authentication_method}get
Port_Access_GBP
Port_Access_GBP_Action_Set
Port_Access_GBP_Entry
Port_Access_LLDP_Group
Port_Access_LLDP_Group_Entry
Port_Access_Policy
Port_Access_Policy_Action_Set
Port_Access_Policy_Entry
Port_Access_Role
Port_Access_VLAN_Group
Power_supply
- /system/subsystems/{Subsystem.type},{Subsystem.name}/power_suppliesget
- /system/subsystems/{Subsystem.type},{Subsystem.name}/power_supplies/{Power_supply.name}get
Prefix_List
Prefix_List_Entry
Protected_Nexthop_Group
- /system/protected_nexthop_groupsget
- /system/protected_nexthop_groups/{Protected_Nexthop_Group.id},{Protected_Nexthop_Group.origin}get
Protected_Nexthop_Group_Config
Q_Profile
Q_Profile_Entry
Q_Threshold_Entry
QoS
QoS_COS_Map_Entry
QoS_DSCP_Map_Entry
Qos_Pool
Qos_Pool_Statistics
- /system/subsystems/{Subsystem.type},{Subsystem.name}/data_planes/{Data_Plane.id}/qos_pool_statisticsget
- /system/subsystems/{Subsystem.type},{Subsystem.name}/data_planes/{Data_Plane.id}/qos_pool_statistics/{Qos_Pool_Statistics.pool_number},{Qos_Pool_Statistics.traffic_manager_id}get
Queue
RA_Guard_Policy
RADIUS_Config_Attribute
Radius_Dynamic_Authorization_Client
Radius_Server
RBAC_Rule_Entry
Recursive_Nexthop
- /system/vrfs/{VRF.name}/recursive_nexthopsget
- /system/vrfs/{VRF.name}/recursive_nexthops/{Recursive_Nexthop.rnh_ip}get
Redundant_Management
- /system/redundant_managementsget
- /system/redundant_managements/{Redundant_Management.name}get
Remote_L2VPN_Neighbor
- /system/vrfs/{VRF.name}/remote_l2vpn_neighborsget
- /system/vrfs/{VRF.name}/remote_l2vpn_neighbors/{Remote_L2VPN_Neighbor.ip_address},{Remote_L2VPN_Neighbor.from},{Remote_L2VPN_Neighbor.port}get
Replication_Group
- /system/replication_groupsget
REST_Config
RIP_Interface
RIP_Neighbor
RIP_Route
RIP_Router
Route
- /system/vrfs/{VRF.name}/routesget
- /system/vrfs/{VRF.name}/routes/{Route.prefix}get
Route_Map
Route_Map_Entry
Route_Resolution
- /system/vrfs/{VRF.name}/route_resolutionsget
- /system/vrfs/{VRF.name}/route_resolutions/{Route_Resolution.origin},{Route_Resolution.address},{Route_Resolution.port}get
Schedule
Service_Label
- /system/service_labelsget
sFlow
sFlow_collector
ShowTech
SimpliVity
SNMP_Alarm
SNMP_Community_ACL
SNMP_Community_Attributes
SNMP_Trap
SNMP_View
SNMP_View_Entry
SNMPv3_Context
SNMPv3_User
SSH_Session
- /system/vrfs/{VRF.name}/ssh_sessionsget
- /system/vrfs/{VRF.name}/ssh_sessions/{SSH_Session.client_ip},{SSH_Session.client_port}get
Static_IP_Binding
Static_MAC
Static_Multicast_Nexthop
Static_Neighbor
Static_Nexthop
Static_PIM_Mroute
Static_PIM_Nexthop
Static_Route
STP_Instance
STP_Instance_Port
Subsystem
Syslog_Remote
System
Tacacs_Server
TELNET_Session
- /system/telnet_sessionsget
- /system/telnet_sessions/{TELNET_Session.vrf},{TELNET_Session.client_ip},{TELNET_Session.client_port}get
Temp_sensor
- /system/subsystems/{Subsystem.type},{Subsystem.name}/temp_sensorsget
- /system/subsystems/{Subsystem.type},{Subsystem.name}/temp_sensors/{Temp_sensor.name}get
Test_Dynamic_Ephemeral
Test_Table_EmptyValue_KCONFIG_Feature
Test_Table_Enum_Doc_Nested_ValueMap_Based_On_Capabilities
- /system/test_table_enum_doc_nested_valuemap_based_on_capabilitiesget
Test_Table_Enum_KCONFIG_Feature
- /system/test_table_enum_kconfig_featuresget
Test_Table_Inner_ValueMap_KCONFIG_Feature
- /system/test_table_inner_valuemap_kconfig_featuresget
Test_Table_One_Capability_Present
- /system/test_table_one_capability_presentsget
Test_Table_One_KCONFIG_Feature_Active
- /system/test_table_one_kconfig_feature_activesget
Test_Table_Two_Capability_Present
Test_Table_ValueMap_Based_On_Capabilities
- /system/test_table_valuemap_based_on_capabilitiesget
Test_Table_ValueMap_KCONFIG_Feature
- /system/test_table_valuemap_kconfig_featuresget
Thermal
- /system/thermalsget
- /system/thermals/{Thermal.name}get
Threshold_Profile
Time_Series
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_monitors/{NAE_Monitor.name}/time_seriesget
- /system/nae_scripts/{NAE_Script.name}/nae_agents/{NAE_Agent.name}/nae_monitors/{NAE_Monitor.name}/time_series/{Time_Series.type}get
Traceroute
- Traceroute result.get
Track_Entity
TShoot_Mcast
TShoot_OSPF
Tunnel_Endpoint
UBT_MDEST_RX_Tunnel
- /system/ubt_mdest_rx_tunnelsget
- /system/ubt_mdest_rx_tunnels/{UBT_MDEST_RX_Tunnel.vrf},{UBT_MDEST_RX_Tunnel.local_ip},{UBT_MDEST_RX_Tunnel.controller_ip}get
UBT_UAC
- /system/vrfs/{VRF.name}/ubt_zones/{UBT_Zone.name}/ubt_uacsget
- /system/vrfs/{VRF.name}/ubt_zones/{UBT_Zone.name}/ubt_uacs/{UBT_UAC.ip_address}get
UBT_UAC_Tunnel
- /system/ubt_uac_tunnelsget
- /system/ubt_uac_tunnels/{UBT_UAC_Tunnel.vrf},{UBT_UAC_Tunnel.source_ip},{UBT_UAC_Tunnel.destination_ip},{UBT_UAC_Tunnel.gre_key}get
UBT_Zone
UDP_Bcast_Forwarder_Server
User
User_Group
Virtual_Network_ID
VLAN
VRF
VRF_Address_Family
VRRP
VSX
VSX_Remote_Interface
- /system/interfaces/{Interface.name}/vsx_remote_interfacesget
- /system/interfaces/{Interface.name}/vsx_remote_interfaces/{VSX_Remote_Interface.name}get
VSX_Remote_Lag
- /system/vsx_remote_lagsget
- /system/vsx_remote_lags/{VSX_Remote_Lag.name}get
YANG_View

/system/vrfs/{VRF.name}/ssh_sessions

get https://switch-ip/rest/v10.15/system/vrfs/{VRF.name}/ssh_sessions

Language

Click Try It! to start a request and see the response here!