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    

AOS-CX API Changelog

v10.08 API Changelog

There are a total of 84 Changes to the API in the v10.08 release

New Endpoints: 30

Method
URI

GET/POST

/system/jobs

GET/PUT/DELETE

/system/jobs/{name}

GET/POST

/system/jobs/{name}/job_entries

GET/PUT/DELETE

/system/jobs/{name}/job_entries/{sequence_number}

GET/POST

/system/qos_pools

GET/DELETE

/system/qos_pools/{pool_id}

GET/POST

/system/radius_config_attributes

GET/PUT/DELETE

/system/radius_config_attributes/{server_group}

GET/POST

/system/schedules

GET/PUT/DELETE

/system/schedules/{name}

GET

/systems/subsystems/{type},{name}/data_planes

GET

/systems/subsystems/{type},{name}/data_planes/{id}

GET/POST/PUT/DELETE

/systems/vrfs/{name}/ntp_conductors

Deleted Endpoints: 4

Method
URI

GET/POST/PUT/DELETE

/system/vrfs/{name}/ntp_masters

Modified Endpoints: 50

GET /system

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [nae_time_series_count console_baudrate console_logging trunk_dynamic_vlan_include http_session jobs qos_pools schedules radius_config_attributes]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: qos_pools
                    New property: console_baudrate
                    New property: nae_time_series_count
                    New property: jobs
                    New property: console_logging
                    New property: http_session
                    New property: radius_config_attributes
                    New property: schedules
                    New property: trunk_dynamic_vlan_include
                    Modified property: capacities
                        Properties changed
                            New property: qos_pool_max_lossless_percent
                            New property: radius_max_servers
                            New property: loopback_internal_vlans_base
                            New property: loopback_internal_vlans
                            New property: qos_pool_min_lossless_percent
                            New property: pim_interfaces_total
                            New property: interface_pause_watchdog_min_resume
                            New property: interface_pfc_max_priorities_combinations
                            New property: interface_pause_watchdog_max_timeout
                            New property: lldp_dcbx_control_tlv_maximum_version
                            New property: device_fingerprint_max_clients
                            New property: device_fingerprint_max_profile
                            New property: pim_interfaces_per_vrf
                            New property: qos_headroom_max_size
                            New property: max_jobs_per_schedule
                            New property: lldp_dcbx_pg_tlv_maximum_version
                            New property: max_data_planes
                            New property: max_job_history
                            New property: lldp_dcbx_application_tlv_maximum_version
                            New property: lldp_dcbx_pfc_tlv_maximum_version
                            New property: radius_max_radsec_servers
                            New property: max_jobs
                            New property: qos_pool_max_packet_buffer_memory
                            New property: nae_time_series
                            New property: max_schedules
                            New property: interface_pause_watchdog_min_timeout
                            New property: interface_pause_watchdog_max_resume
                            New property: qos_pool_max_id
                    Modified property: capacities_status
                        Properties changed
                            New property: max_data_planes
                    Modified property: capabilities
                        Items changed
                            New enum values: [classifier_acl_mac_subinterface_in classifier_acl_mac_subinterface_out classifier_acl_v4_subinterface_in classifier_acl_v4_subinterface_out classifier_acl_v6_subinterface_in classifier_acl_v6_subinterface_out classifier_policy_subinterface_in classifier_policy_subinterface_out classifier_policy_subinterface_routed_in copp_class_dfp_collector counter_l3_vlan_ip subinterface_requires_ingress_vid_remap_resource mcast_zero_address_as_source ptp_tranparent_clock_support ptp_boundary_clock_support qos_intf_xoff_limit_dynamic qos_pool_lossless_config_percent qos_pool_statistics qos_pool_statistics_peak qos_threshold_profiles_max_point interface_flowcontrol_watchdog_pfc ospf_admin_distance_support device_fingerprinting]
                    Modified property: other_config
                        Properties changed
                            New property: mac_notify_enable
                            New property: lldp_dcbx_version
                            New property: mac_notify_interval
                    Modified property: mgmt_intf_status
                        Properties changed
                            New property: ipv6
                            New property: default_gateway_v6

PUT /system

Request body changed
    Content changed
        Schema changed
            Properties changed
                New property: jobs
                New property: radius_config_attributes
                New property: console_logging
                New property: trunk_dynamic_vlan_include
                New property: schedules
                New property: http_session
                New property: console_baudrate
                Modified property: other_config
                    Properties changed
                        New property: lldp_dcbx_version
                        New property: mac_notify_enable
                        New property: mac_notify_interval

GET /system/acls

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [statistics_clear_requested statistics_clear_performed]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: statistics_clear_requested
                    New property: statistics_clear_performed

POST /system/acls

Request body changed
    Content changed
        Schema changed
            Properties changed
                New property: statistics_clear_requested

GET /system/acls/{name},{list_type}

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [statistics_clear_requested statistics_clear_performed]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: statistics_clear_performed
                    New property: statistics_clear_requested

PUT /system/acls/{name},{list_type}

Request body changed
    Content changed
        Schema changed
            Properties changed
                New property: statistics_clear_requested

GET /system/dlogs

Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    Modified property: sub_module
                        New enum values: [lag_protocol dpmgmt_ptp]
                    Modified property: module
                        New enum values: [smf]

POST /system/dlogs

Request body changed
    Content changed
        Schema changed
            Properties changed
                Modified property: module
                    New enum values: [smf]
                Modified property: sub_module
                    New enum values: [lag_protocol dpmgmt_ptp]

DELETE /system/dlogs/{module},{sub_module}

Modified path param: module
    Schema changed
        New enum values: [smf]
Modified path param: sub_module
    Schema changed
        New enum values: [lag_protocol dpmgmt_ptp]

GET /system/dlogs/{module},{sub_module}

Modified path param: module
    Schema changed
        New enum values: [smf]
Modified path param: sub_module
    Schema changed
        New enum values: [lag_protocol dpmgmt_ptp]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    Modified property: sub_module
                        New enum values: [lag_protocol dpmgmt_ptp]
                    Modified property: module
                        New enum values: [smf]

PUT /system/dlogs/{module},{sub_module}

Modified path param: module
    Schema changed
        New enum values: [smf]
Modified path param: sub_module
    Schema changed
        New enum values: [lag_protocol dpmgmt_ptp]
Request body changed
    Content changed
        Schema changed
            Properties changed
                Modified property: sub_module
                    New enum values: [lag_protocol dpmgmt_ptp]
                Modified property: module
                    New enum values: [smf]

GET /system/interfaces

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [igmp_router_alert_check_enable mac_notify_type pause_watchdog_queue_triggers pim_datapath_auto_include vlan_translation_rules_in_hw]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: pause_watchdog_queue_triggers
                    Modified property: forwarding_state
                        Properties changed
                            Modified property: blocking_trigger
                                New enum values: [ACL_INIT_FOR_L3 PRECISION_TIME_PROTOCOL SUBINTERFACE_OPER_STATE]
                    Modified property: status
                        Properties changed
                            Modified property: dcbx_status
                                New enum values: [version_mismatch]
                    Modified property: user_config
                        Properties changed
                            New property: link_clock_tolerance
                    Modified property: dcbx_status
                        Properties changed
                            New property: dcbx_num_tc_supported
                            New property: dcbx_pfc_num_tc_supported
                    Modified property: pm_info
                        Properties changed
                            New property: dom_last_refresh_timestamp
                            New property: dom_refresh_interval
                            New property: thermal_class
                            Modified property: connector
                                New enum values: [QSFP28_BIDI]
                    Modified property: capabilities
                        Items changed
                            New enum values: [link_clock_tolerance_config]
                    Modified property: other_config
                        Properties changed
                            New property: lldp_dcbx_version

POST /system/interfaces

Request body changed
    Content changed
        Schema changed
            Properties changed
                New property: pim_datapath_auto_include
                New property: mac_notify_type
                New property: igmp_router_alert_check_enable
                Modified property: vsx_sync
                    Items changed
                        New enum values: [device_fingerprint_configuration pim_mode pim_bfd pim_trig_hello_interval pim_hello_interval pim_lan_prune_delay_disable pim_override_interval pim_propagation_delay pim_vsx_virtual_neighbor pim_source_address]
                Modified property: other_config
                    Properties changed
                        New property: lldp_dcbx_version
                Modified property: user_config
                    Properties changed
                        New property: link_clock_tolerance

GET /system/interfaces/{name}

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [igmp_router_alert_check_enable mac_notify_type pause_watchdog_queue_triggers pim_datapath_auto_include vlan_translation_rules_in_hw]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: pause_watchdog_queue_triggers
                    Modified property: capabilities
                        Items changed
                            New enum values: [link_clock_tolerance_config]
                    Modified property: dcbx_status
                        Properties changed
                            New property: dcbx_num_tc_supported
                            New property: dcbx_pfc_num_tc_supported
                    Modified property: status
                        Properties changed
                            Modified property: dcbx_status
                                New enum values: [version_mismatch]
                    Modified property: user_config
                        Properties changed
                            New property: link_clock_tolerance
                    Modified property: other_config
                        Properties changed
                            New property: lldp_dcbx_version
                    Modified property: forwarding_state
                        Properties changed
                            Modified property: blocking_trigger
                                New enum values: [ACL_INIT_FOR_L3 PRECISION_TIME_PROTOCOL SUBINTERFACE_OPER_STATE]
                    Modified property: pm_info
                        Properties changed
                            New property: dom_refresh_interval
                            New property: dom_last_refresh_timestamp
                            New property: thermal_class
                            Modified property: connector
                                New enum values: [QSFP28_BIDI]

PUT /system/interfaces/{name}

Request body changed
    Content changed
        Schema changed
            Properties changed
                New property: pim_datapath_auto_include
                New property: igmp_router_alert_check_enable
                New property: mac_notify_type
                Modified property: other_config
                    Properties changed
                        New property: lldp_dcbx_version
                Modified property: vsx_sync
                    Items changed
                        New enum values: [device_fingerprint_configuration pim_mode pim_bfd pim_trig_hello_interval pim_hello_interval pim_lan_prune_delay_disable pim_override_interval pim_propagation_delay pim_vsx_virtual_neighbor pim_source_address]
                Modified property: user_config
                    Properties changed
                        New property: link_clock_tolerance

GET /system/interfaces/{name}/lldp_neighbors

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [dcbx_cee_status]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: dcbx_cee_status
                    Modified property: neighbor_info
                        Properties changed
                            New property: dcbx_pg_operating_version
                            New property: dcbx_control_operating_version
                            New property: dcbx_pfc_operating_version
                            New property: dcbx_application_operating_version
                            New property: dcbx_pfc_error
                            New property: dcbx_control_sequence_number
                            New property: dcbx_application_error
                            New property: dcbx_pg_enabled
                            New property: dcbx_application_enabled
                            New property: dcbx_pg_maximum_version
                            New property: dcbx_control_maximum_version
                            New property: dcbx_pg_error
                            New property: dcbx_version
                            New property: dcbx_pfc_maximum_version
                            New property: dcbx_application_willing
                            New property: dcbx_control_acknowledgement_number
                            New property: dcbx_pfc_enabled
                            New property: dcbx_application_maximum_version

GET /system/interfaces/{name}/lldp_neighbors/{chassis_id},{port_id}

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [dcbx_cee_status]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: dcbx_cee_status
                    Modified property: neighbor_info
                        Properties changed
                            New property: dcbx_control_operating_version
                            New property: dcbx_pfc_operating_version
                            New property: dcbx_control_acknowledgement_number
                            New property: dcbx_application_operating_version
                            New property: dcbx_pfc_error
                            New property: dcbx_pg_operating_version
                            New property: dcbx_version
                            New property: dcbx_application_willing
                            New property: dcbx_application_enabled
                            New property: dcbx_pg_enabled
                            New property: dcbx_pg_maximum_version
                            New property: dcbx_control_sequence_number
                            New property: dcbx_pfc_maximum_version
                            New property: dcbx_pg_error
                            New property: dcbx_application_error
                            New property: dcbx_control_maximum_version
                            New property: dcbx_application_maximum_version
                            New property: dcbx_pfc_enabled

GET /system/nae_scripts/{name}/nae_agents

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [nae_alerts_count nae_time_series_count]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: nae_time_series_count
                    New property: nae_alerts_count

GET /system/nae_scripts/{name}/nae_agents/{name}

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [nae_alerts_count nae_time_series_count]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: nae_time_series_count
                    New property: nae_alerts_count

GET /system/policies

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [statistics_requested_vrf statistics_clear_requested statistics_clear_performed routed_in_statistics_clear_requested parent_policy routed_in_statistics_clear_performed]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: parent_policy
                    New property: statistics_clear_performed
                    New property: routed_in_statistics_clear_performed
                    New property: statistics_clear_requested
                    New property: routed_in_statistics_clear_requested
                    New property: statistics_requested_vrf

POST /system/policies

Request body changed
    Content changed
        Schema changed
            Properties changed
                New property: statistics_requested_vrf
                New property: parent_policy
                New property: routed_in_statistics_clear_requested
                New property: statistics_clear_requested

GET /system/policies/{name}

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [statistics_requested_vrf statistics_clear_requested statistics_clear_performed routed_in_statistics_clear_requested parent_policy routed_in_statistics_clear_performed]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: statistics_clear_performed
                    New property: routed_in_statistics_clear_performed
                    New property: statistics_requested_vrf
                    New property: parent_policy
                    New property: routed_in_statistics_clear_requested
                    New property: statistics_clear_requested

PUT /system/policies/{name}

Request body changed
    Content changed
        Schema changed
            Properties changed
                New property: statistics_requested_vrf
                New property: routed_in_statistics_clear_requested
                New property: statistics_clear_requested

GET /system/stp_instances/{instance_type},{stp_instance_id}/stp_instance_ports

Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    Modified property: vsx_peer_info
                        Properties changed
                            New property: port_inconsistent_pvid_mismatch
                    Modified property: port_inconsistent
                        Properties changed
                            New property: pvid_mismatch

GET /system/stp_instances/{instance_type},{stp_instance_id}/stp_instance_ports/{port}

Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    Modified property: port_inconsistent
                        Properties changed
                            New property: pvid_mismatch
                    Modified property: vsx_peer_info
                        Properties changed
                            New property: port_inconsistent_pvid_mismatch

GET /system/subsystems

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [data_planes]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: data_planes
                    Modified property: capabilities
                        Items changed
                            New enum values: [poe_config_limit]
                    Modified property: data_plane_error
                        Properties changed
                            Modified property: reason
                                New enum values: [internal_vsf]
                    Modified property: data_plane_target_state
                        New enum values: [timeout]

GET /system/subsystems/{type},{name}

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [data_planes]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: data_planes
                    Modified property: data_plane_error
                        Properties changed
                            Modified property: reason
                                New enum values: [internal_vsf]
                    Modified property: capabilities
                        Items changed
                            New enum values: [poe_config_limit]
                    Modified property: data_plane_target_state
                        New enum values: [timeout]

GET /system/subsystems/{type},{name}/power_supplies

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [redundant_psu]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: redundant_psu
                    Modified property: identity
                        Properties changed
                            New property: voltage_type
                            New property: input_voltage_high
                            New property: input_voltage_low

GET /system/subsystems/{type},{name}/power_supplies/{name}

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [redundant_psu]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: redundant_psu
                    Modified property: identity
                        Properties changed
                            New property: input_voltage_high
                            New property: input_voltage_low
                            New property: voltage_type

GET /system/vlans

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [delete_macs_rejected delete_macs_requested]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: delete_macs_requested
                    New property: delete_macs_rejected
                    Modified property: oper_state_reason
                        New enum values: [pvlan_primary_down]
                    Modified property: type
                        New enum values: [port-access]

POST /system/vlans

Request body changed
    Content changed
        Schema changed
            Properties changed
                New property: delete_macs_requested
                Modified property: type
                    New enum values: [port-access]

GET /system/vlans/{id}

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [delete_macs_rejected delete_macs_requested]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: delete_macs_requested
                    New property: delete_macs_rejected
                    Modified property: oper_state_reason
                        New enum values: [pvlan_primary_down]
                    Modified property: type
                        New enum values: [port-access]

PUT /system/vlans/{id}

Request body changed
    Content changed
        Schema changed
            Properties changed
                New property: delete_macs_requested
                Modified property: type
                    New enum values: [port-access]

GET /system/vrfs

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [ntp_conductors]
            Deleted enum values: [ntp_masters]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: ntp_conductors
                    Deleted property: ntp_masters

POST /system/vrfs

Request body changed
    Content changed
        Schema changed
            Properties changed
                New property: ntp_conductors
                Deleted property: ntp_masters

GET /system/vrfs/{name}

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [ntp_conductors]
            Deleted enum values: [ntp_masters]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: ntp_conductors
                    Deleted property: ntp_masters

PUT /system/vrfs/{name}

Request body changed
    Content changed
        Schema changed
            Properties changed
                New property: ntp_conductors
                Deleted property: ntp_masters

GET /system/vrfs/{name}/bgp_routers/{asn}/bgp_neighbors

Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    Modified property: password
                        MaxLength changed from 90 to 128

POST /system/vrfs/{name}/bgp_routers/{asn}/bgp_neighbors

Request body changed
    Content changed
        Schema changed
            Properties changed
                Modified property: password
                    MaxLength changed from 90 to 128

GET /system/vrfs/{name}/bgp_routers/{asn}/bgp_neighbors/{ip_or_ifname_or_group_name}

Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    Modified property: password
                        MaxLength changed from 90 to 128

PUT /system/vrfs/{name}/bgp_routers/{asn}/bgp_neighbors/{ip_or_ifname_or_group_name}

Request body changed
    Content changed
        Schema changed
            Properties changed
                Modified property: password
                    MaxLength changed from 90 to 128

GET /system/vrfs/{name}/ntp_associations

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [origin]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: origin

POST /system/vrfs/{name}/ntp_associations

Request body changed
    Content changed
        Schema changed
            Properties changed
                New property: origin

GET /system/vrfs/{name}/ntp_associations/{address}

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [origin]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: origin

GET /system/vrfs/{name}/route_resolutions/{origin},{address},{port}

Modified path param: origin
    Schema changed
        New enum values: [rdisc nae]

GET /system/vrfs/{name}/routes/{prefix}/nexthops

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [type]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: type

GET /system/vrfs/{name}/routes/{prefix}/nexthops/{uuid}

Modified query param: attributes
    Schema changed
        Items changed
            New enum values: [type]
Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    New property: type

GET /system/vsx

Responses changed
    Modified response: 200
        Content changed
            Schema changed
                Properties changed
                    Modified property: config_sync_features
                        MaxItems changed from 42 to 45
                        Items changed
                            New enum values: [msdp-global pim]

POST /system/vsx

Request body changed
    Content changed
        Schema changed
            Properties changed
                Modified property: config_sync_features
                    MaxItems changed from 42 to 45
                    Items changed
                        New enum values: [msdp-global pim]

PUT /system/vsx

Request body changed
    Content changed
        Schema changed
            Properties changed
                Modified property: config_sync_features
                    MaxItems changed from 42 to 45
                    Items changed
                        New enum values: [msdp-global pim]

Updated 3 months ago


AOS-CX API Changelog


Suggested Edits are limited on API Reference Pages

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