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

ArubaOS-CX REST API

AAA_Accounting_Attributes
AAA_Server_Group
AAA_Server_Group_Prio
ACL
ACL_Entry
ACL_Object_Group
ADC_List
- /system/adc_lists/{name},{list_type}get
- /system/adc_listsget
Aggregate_address
Aruba_Central
- /system/aruba_centralget
- /system/aruba_centralput
BFD_Session
- /system/vrfs/{name}/bfd_sessionsget
- /system/vrfs/{name}/bfd_sessions/{from},{from_instance_id},{operating_mode},{dst_ip},{src_port}get
BGP_ASPath_Filter
BGP_ASPath_Filter_Entry
BGP_Community_Filter
BGP_Community_Filter_Entry
BGP_Neighbor
BGP_Route
- /system/vrfs/{name}/bgp_routesget
- /system/vrfs/{name}/bgp_routes/{prefix},{peer},{vni},{path_id}get
BGP_Router
Boot
- Reboot the specified firmware image(s).post
Button
- /system/subsystems/{type},{name}/buttonsget
- /system/subsystems/{type},{name}/buttons/{name}get
Captive_Portal_Profile
CDP_Neighbor
- /system/interfaces/{name}/cdp_neighborsget
- /system/interfaces/{name}/cdp_neighbors/{mac_addr}get
CertificateManager
Class
Class_Entry
Clear_OSPF_neighbor
CLI_Alias
Configuration
CoPP_Policy
Container
CoPP_Policy_Entry
Daemon
- /system/subsystems/{type},{name}/daemons/{name}get
- /system/subsystems/{type},{name}/daemonsget
Device_Profile
DHCP_Lease
- /system/vrfs/{name}/dhcp_leases/{ip_address}get
- /system/vrfs/{name}/dhcp_leasesget
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/{type},{name}/diag_test_resultsget
- /system/subsystems/{type},{name}/diag_test_results/{mgmt_module},{name}get
DLog
EVPN
EVPN_Instance
- /system/evpn_instances/{evi}get
- /system/evpn_instancesget
EVPN_MAC_IP
- /system/evpn_mac_ipsget
- /system/evpn_mac_ips/{evi},{mac_address}get
EVPN_VLAN
External_Storage
Fan
- /system/subsystems/{type},{name}/fansget
- /system/subsystems/{type},{name}/fans/{name}get
Firmware
GBP_Role_Name_Id_Map
HSC
Interface
IP6_Address
IP_Binding
- /system/ip_bindingsget
- /system/ip_bindings/{vlan},{ip_address}get
IPsec_SA
- /system/vrfs/{name}/ipsec_sas/{SPI},{ipsec_protocol},{address_family},{dest_ip},{direction}get
- /system/vrfs/{name}/ipsec_sasget
IPsec_SP
- /system/vrfs/{name}/ipsec_spsget
ipsla_responder
ipsla_responder_statistics
- /system/ipsla_responders/{name}/ipsla_responder_statistics/{source_ip},{source_port},{vrf}get
- /system/ipsla_responders/{name}/ipsla_responder_statisticsget
ipsla_source
IPv6_Destination_Guard_Policy
IVRL_Neighbor
- /system/vrfs/{name}/ivrl_neighborsget
- /system/vrfs/{name}/ivrl_neighbors/{ip_address},{port}get
Key
Keychain
LED
LLDP_Neighbor
- /system/interfaces/{name}/lldp_neighbors/{chassis_id},{port_id}get
- /system/interfaces/{name}/lldp_neighborsget
Logging_Filter
Logging_Filter_Entry
Login
- User login.post
Logout
- User logout.post
Logs
- Log entries.get
- Audit logs.get
MAC
- /system/vlans/{id}/macsget
- /system/vlans/{id}/macs/{from},{mac_addr}get
MAC_Group
MAC_Group_Entry
MAC_Lockout
MACsec_KaY_MKA
- /system/macsec_kay_mkasget
MACsec_KaY_MKA_Participant
- /system/macsec_kay_mka_participantsget
MACsec_KaY_MKA_Peer
- /system/macsec_kay_mka_peersget
MACsec_Policy
MACsec_Secure_Association
- /system/macsec_secure_associationsget
MACsec_Secure_Channel
- /system/interfaces/{name}/macsec_secies/{id}/macsec_secure_channels/{sci},{channel_type}get
- /system/interfaces/{name}/macsec_secies/{id}/macsec_secure_channelsget
MACsec_SecY
- /system/interfaces/{name}/macsec_secies/{id}get
- /system/interfaces/{name}/macsec_seciesget
MGMD_PGS
- /system/interfaces/{name}/mgmd_pgsget
- /system/interfaces/{name}/mgmd_pgs/{mgmd_type},{group_ip},{source_ip}get
MGMD_VGPS
- /system/vlans/{id}/mgmd_vgs/{mgmd_type},{group_ip},{source_ip},{filter_type}/vgps_entries/{port}get
- /system/vlans/{id}/mgmd_vgs/{mgmd_type},{group_ip},{source_ip},{filter_type}/vgps_entriesget
MGMD_VGS
- /system/vlans/{id}/mgmd_vgs/{mgmd_type},{group_ip},{source_ip},{filter_type}get
- /system/vlans/{id}/mgmd_vgsget
Mirror
MKA_Policy
MSDP_Peer
MSDP_Router
MSDP_SA_Cache
- /system/vrfs/{name}/msdp_router/msdp_peers/{address}/msdp_sa_caches/{source_address},{group_address},{rp_address}get
- /system/vrfs/{name}/msdp_router/msdp_peers/{address}/msdp_sa_cachesget
MTrace
- /system/mtraces/{source_address},{group_address},{vrf},{timestamp}get
- /system/mtracesget
Multicast_L3_Bridge_Control_Forwarding
- /system/vrfs/{name}/multicast_l3_bridge_control_forwardingsget
- /system/vrfs/{name}/multicast_l3_bridge_control_forwardings/{source_prefix},{destination_prefix},{VLAN}get
Multicast_L3_Forwarding
- /system/vrfs/{name}/multicast_l3_forwardings/{source_prefix},{destination_prefix},{upstream_port}get
- /system/vrfs/{name}/multicast_l3_forwardingsget
Multicast_L3_Neighbor_Forwarding
- /system/interfaces/{name}/multicast_l3_neighbor_forwardingsget
- /system/interfaces/{name}/multicast_l3_neighbor_forwardings/{from},{destination_address}get
Multicast_Replication_Portset
- /system/multicast_replication_portsetsget
MVRP_VLAN
- /system/interfaces/{name}/mvrp_vlansget
- /system/interfaces/{name}/mvrp_vlans/{vlan-id}get
NAE
- Delete/Clear Time Series and Alerts Datadelete
NAE_Action
- /system/nae_scripts/{name}/nae_agents/{name}/nae_rules/{name}/nae_conditions/{type}/actionsget
- /system/nae_scripts/{name}/nae_agents/{name}/nae_rules/{name}/nae_conditions/{type}/actions/{name}get
NAE_Action_Result
- Get the full NAE Action resultget
- Get the NAE Action resultget
NAE_Agent
NAE_Baseline
- /system/nae_scripts/{name}/nae_agents/{name}/nae_baselines/{name}get
- /system/nae_scripts/{name}/nae_agents/{name}/nae_baselinesget
NAE_Condition
- /system/nae_scripts/{name}/nae_agents/{name}/nae_rules/{name}/nae_conditionsget
- /system/nae_scripts/{name}/nae_agents/{name}/nae_rules/{name}/nae_conditions/{type}get
NAE_Condition_Event
- /system/nae_scripts/{name}/nae_agents/{name}/nae_rules/{name}/nae_conditions/{type}/nae_condition_events/{name}get
- /system/nae_scripts/{name}/nae_agents/{name}/nae_rules/{name}/nae_conditions/{type}/nae_condition_eventsget
NAE_Graph
- /system/nae_scripts/{name}/nae_agents/{name}/nae_graphs/{name}get
- /system/nae_scripts/{name}/nae_agents/{name}/nae_graphsget
NAE_Monitor
- /system/nae_scripts/{name}/nae_agents/{name}/nae_monitors/{name}get
- /system/nae_scripts/{name}/nae_agents/{name}/nae_monitorsget
NAE_Parameter
- /system/nae_scripts/{name}/nae_parametersget
- /system/nae_scripts/{name}/nae_parameters/{name}get
NAE_Rule
- /system/nae_scripts/{name}/nae_agents/{name}/nae_rules/{name}get
- /system/nae_scripts/{name}/nae_agents/{name}/nae_rulesget
NAE_Script
Neighbor
- /system/vrfs/{name}/neighborsget
- /system/vrfs/{name}/neighbors/{ip_address},{port}get
Nexthop
- /system/vrfs/{name}/routes/{prefix}/nexthopsget
- /system/vrfs/{name}/routes/{prefix}/nexthops/{uuid}get
Notification_Subscriber
- /system/notification_subscribers/{name}get
- /system/notification_subscribersget
Notification_Subscription
- /system/notification_subscribers/{name}/notification_subscriptionsget
- /system/notification_subscribers/{name}/notification_subscriptions/{name}get
NTP_Association
NTP_Key
NTP_Master
OSPF_Area
OSPF_Interface
OSPF_LSA
OSPF_Neighbor
OSPF_Route
OSPF_Router
OSPF_Summary_Address
OSPF_Vlink
OSPFv3_LSA
PBR_Action_List
PBR_Action_List_Entry
PIM_Clear_Mroute_Request
PIM_Group_Mapping
- /system/vrfs/{name}/pim_routers/{ip_version}/pim_group_mappings/{group_prefix},{rp_address}get
- /system/vrfs/{name}/pim_routers/{ip_version}/pim_group_mappingsget
PIM_Local_Group_Source
- /system/vrfs/{name}/pim_routers/{ip_version}/pim_local_group_sourcesget
- /system/vrfs/{name}/pim_routers/{ip_version}/pim_local_group_sources/{source_address},{group_address},{rp_address}get
PIM_Mroute
- /system/interfaces/{name}/pim_mroutesget
- /system/interfaces/{name}/pim_mroutes/{source_address},{group_address}get
PIM_Neighbor
- /system/interfaces/{name}/pim_neighborsget
- /system/interfaces/{name}/pim_neighbors/{neighbor_address}get
PIM_Nexthop
- /system/interfaces/{name}/pim_mroutes/{source_address},{group_address}/pim_nexthopsget
- /system/interfaces/{name}/pim_mroutes/{source_address},{group_address}/pim_nexthops/{uuid}get
PIM_Router
PIM_Static_RP
Ping
- Ping result.get
PKI_EST_Profile
PKI_TA_Profile
Plugin
- /system/subsystems/{type},{name}/daemons/{name}/pluginsget
- /system/subsystems/{type},{name}/daemons/{name}/plugins/{name}get
PoE_Interface
- /system/interfaces/{name}/poe_interfaceget
- /system/interfaces/{name}/poe_interfaceput
Policy
Policy_Action_Set
Policy_Entry
Port_Access_Auth_Configuration
Port_Access_CDP_Group
Port_Access_CDP_Group_Entry
Port_Access_Client
- /system/interfaces/{name}/port_access_clients/{mac}get
- /system/interfaces/{name}/port_access_clientsget
Port_Access_Client_Auth_Attribute
- /system/interfaces/{name}/port_access_clients/{mac}/auth_attributesget
- /system/interfaces/{name}/port_access_clients/{mac}/auth_attributes/{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/{type},{name}/power_suppliesget
- /system/subsystems/{type},{name}/power_supplies/{name}get
Prefix_List
Prefix_List_Entry
Q_Profile
Q_Profile_Entry
Q_Threshold_Entry
QoS
QoS_COS_Map_Entry
RIB
QoS_DSCP_Map_Entry
Rib_Nexthop
Queue
RADIUS_Config_Attribute
Radius_Dynamic_Authorization_Client
Radius_Server
RBAC_Rule_Entry
Recursive_Nexthop
- /system/vrfs/{name}/recursive_nexthops/{rnh_ip}get
- /system/vrfs/{name}/recursive_nexthopsget
Redundant_Management
- /system/redundant_managementsget
- /system/redundant_managements/{name}get
Remote_L2VPN_Neighbor
- /system/vrfs/{name}/remote_l2vpn_neighbors/{ip_address},{from},{port}get
- /system/vrfs/{name}/remote_l2vpn_neighborsget
Replication_Group
- /system/replication_groupsget
RIP_Interface
RIP_Neighbor
RIP_Route
RIP_Router
Route
- /system/vrfs/{name}/routesget
- /system/vrfs/{name}/routes/{prefix}get
Route_Map
Route_Map_Entry
Route_Resolution
- /system/vrfs/{name}/route_resolutionsget
- /system/vrfs/{name}/route_resolutions/{origin},{address},{port}get
sFlow
sFlow_collector
ShowTech
SimpliVity
SNMP_Alarm
SNMP_Community_ACL
SNMP_Trap
SNMPv3_Context
SNMPv3_User
SSH_Session
- /system/vrfs/{name}/ssh_sessionsget
- /system/vrfs/{name}/ssh_sessions/{client_ip},{client_port}get
Static_IP_Binding
Static_MAC
Static_Multicast_Nexthop
Static_Neighbor
Static_Nexthop
Static_Route
STP_Instance
STP_Instance_Port
Subsystem
Syslog_Remote
System
- /systemput
- /systemget
Tacacs_Server
Temp_sensor
- /system/subsystems/{type},{name}/temp_sensorsget
- /system/subsystems/{type},{name}/temp_sensors/{name}get
Thermal
- /system/thermals/{name}get
- /system/thermalsget
Threshold_Profile
Time_Series
- /system/nae_scripts/{name}/nae_agents/{name}/nae_monitors/{name}/time_series/{type}get
- /system/nae_scripts/{name}/nae_agents/{name}/nae_monitors/{name}/time_seriesget
Traceroute
- Traceroute result.get
Track_Entity
Tunnel_Endpoint
UBT_MDEST_RX_Tunnel
- /system/ubt_mdest_rx_tunnels/{vrf},{local_ip},{controller_ip}get
- /system/ubt_mdest_rx_tunnelsget
UBT_UAC
- /system/vrfs/{name}/ubt_zones/{name}/ubt_uacsget
- /system/vrfs/{name}/ubt_zones/{name}/ubt_uacs/{ip_address}get
UBT_UAC_Tunnel
- /system/ubt_uac_tunnelsget
- /system/ubt_uac_tunnels/{vrf},{source_ip},{destination_ip},{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/{name}/vsx_remote_interfacesget
- /system/interfaces/{name}/vsx_remote_interfaces/{name}get
VSX_Remote_Lag
- /system/vsx_remote_lags/{name}get
- /system/vsx_remote_lagsget

Install signed certificate

put https://switch-ip/rest/v10.04/certificates/{certificate_name}

Install signed certificate

Language

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