Extreme SLX-OS REST API Guide, 20.5.1
> Overview of the SLX-OS REST API
Published April 2023
Search this document
Print this page
Email this page
View PDF
Previous
Next
Preface
Text Conventions
Documentation and Training
Help and Support
Send Feedback
About This Document
What‘s New in this Document
Supported Hardware
Using the Extreme SLX-OS REST API
Before you begin
Transport protocol requirements
Logging in and out
Supported operations
Media types
XML resource representation
HTTP header
HTTP status code and messages
Overview of the SLX-OS REST API
REST API
Resources
Base resource
Protocol support
URIs
URI structure
Configuration APIs
aaa/accounting
aaa/authentication
acl-policy
alias-config
arp
banner
bridge-domain
chassis
clock
delete configuration
display running-configuration
dot1x
filter-change-update-delay
hardware
interface/{interface-type}/{interface-name}/delay-link-event
interface/{interface-type}/{interface-name}/dot1x
interface/{interface-type}/{interface-name}/ip
interface/{interface-type}/{interface-name}/ip/access-group
interface/{interface-type}/{interface-name}/ip/arp-aging-timeout
interface/{interface-type}/{interface-name}/ip/dhcp/relay/gateway
interface/{interface-type}/{interface-name}/ip/dhcp/relay/servers
interface/{interface-type}/{interface-name}/ip/igmp
interface/{interface-type}/{interface-name}/ip/policy
interface/{interface-type}/{interface-name}/ip/proxy-arp
interface/{interface-type}/{interface-name}/ip/router/isis
interface/{interface-type}/{interface-name}/ip/vrrp-extended
interface/{interface-type}/{interface-name}/ipv6/access-group
interface/{interface-type}/{interface-name}/ipv6/dhcp/relay
interface/{interface-type}/{interface-name}/ipv6/nd
interface/{interface-type}/{interface-name}/ipv6/ospf
interface/{interface-type}/{interface-name}/ipv6/policy
interface/{interface-type}/{interface-name}/ipv6/router/isis
interface/{interface-type}/{interface-name}/ipv6/vrrp-extended
interface/{interface-type}/{interface-name}/isis
interface/{interface-type}/{interface-name}/link-error-disable
interface/{interface-type}/{interface-name}/link-fault-signaling
interface/{interface-type}/{interface-name}/link-oam
interface/{interface-type}/{interface-name}/lldp
interface/{interface-type}/{interface-name}/loop-detection
interface/{interface-type}/{interface-name}/qos
interface/{interface-type}/{interface-name}/nd/ra-dns-server
interface/{interface-type}/{interface-name}/rmon/collection
interface/{interface-type}/{interface-name}/sflow
interface/{interface-type}/{interface-name}/spanning-tree
interface/{interface-type}/{interface-name}/storm-control/ingress
interface/{interface-type}/{interface-name}/switchport
interface/{interface-type}/{interface-name}/switchport/port-security
interface/{interface-type}/{interface-name}/vrrp-extended-group
interface/{interface-type}/{interface-name}/vrrp-group
interface/Port-channel
interface/tunnel
interface/vlan/{vlan-number}/suppress-nd
interface/vlan/{vlan-number}/suppress-arp
ip/access-list
ip/as-path
ip/community-list
ip/extcommunity-list
ip/dhcp/relay
ip/dhcp/snooping
ip/dhcp/snooping/trust
ip/igmp
ip/irdp
ip/prefix-list
ip/route
ip/source-guard
ipv6/access-list
ipv6/nd
ipv6/prefix-list
ipv6/router/ospf
ldap-server
ldap-server/host
ldap-server/maprole
link-fault-signaling
lvtep/broadcast-local-bias
mac
monitor/session
ntp
overlay
password-attributes
password-attributes/character-restriction
prefix-independent-convergence
protocol/cfm
protocol/cfm/y1731
protocol/link-oam
protocol/lldp
protocol/loop-detection
protocol/spanning-tree/mstp
protocol/spanning-tree/pvst
protocol/spanning-tree/rpvst
protocol/spanning-tree/rstp
protocol/spanning-tree/stp
protocol/vrrp
protocol/vrrp-extended
qos-mpls
radius-server
role
route-map
router/bgp
router/isis
router/mpls
router/mpls/autobw-template
router/mpls/autobw-threshold-table
router/mpls/bypass-lsp
router/mpls/dynamic-bypass
router/mpls/ldp
router/mpls/lsp
router/mpls/mpls-interface
router/mpls/policy
router/mpls/rsvp
router/ospf
router/pim
rmon
rule/{rule-name}/action
rule/{rule-name}/command/show running-config
sflow
system-monitor
system-monitor/tm
system-monitor-mail
system-monitor-mail/fru
system-monitor-mail/interface
system-monitor-mail/relay
system-monitor-mail/security
system-monitor-mail/sfp
tacacs-server
topology-group
username
vlan
vlan/dot1q
vlan/{vlan-name}/loop-detection
vlan/{vlan-name}/mac
vrf
Operational-state APIs
adj-neighbor-entries-state
app-telemetry-acl-list-state
app-telemetry-counters-state
bd-mac-br-state
bd-vc-peer-state
bridge-domain-mac-state
bridge-domain-state
bridge-domain-state/bridge-domain-list
cfm-state
cluster-ext-state
cluster-member-bd-state
cluster-member-vlan-state
cluster-state
counts-state
cpu-state
debug-isis-info-state
dhcp-snooping-option-state
dhcp-snooping-state
erp-clear-state
erp-debug-state
erp-show-debug-state
erp-state
hw-state
igmp-snooping-state
isis-state
isis-state/database
isis-state/host-table
isis-state/interface-brief
isis-state/interface-detail
isis-state/ipv4-routes
isis-state/ipv6-routes
isis-state/router-isis-config
loam-state
logical-interface-state
mem-state
mctd-client-state-state
mct-l2ys-state
mct-state
mpls-state
mpls-state/auto-bandwidth-template
mpls-state/autobw-threshold-table-entry
mpls-state/autobw-threshold-table-summary
mpls-state/dynamic-bypass
mpls-state/forwarding-entry
mpls-state/interface
mpls-state/ldp
mpls-state/ldp/fec
mpls-state/ldp/fec/ldp-fec-prefix-prefix
mpls-state/ldp/fec/ldp-fec-prefixes
mpls-state/ldp/fec/ldp-fec-summary
mpls-state/ldp/fec/ldp-fec-vcs
mpls-state/ldp/interface
mpls-state/ldp/ldp-session
mpls-state/ldp/ldp-session-summary
mpls-state/ldp/statistics
mpls-state/ldp/tunnels
mpls-state/ldp/tunnels/ldp-tunnels
mpls-state/lsp
mpls-state/memory
mpls-state/path
mpls-state/policy
mpls-state/policy/admin-groups
mpls-state/route
mpls-state/rsvp
mpls-state/rsvp/igp-sync
mpls-state/rsvp/interfaces
mpls-state/rsvp/neighbors
mpls-state/rsvp/statistics
mpls-state/rsvp/statistics/packet-counters
mpls-state/rsvp/statistics/packet-error-counters
mpls-state/statistics-oam
mpls-state/summary
mpls-state/te
mpls-state/te/router-id-map
overlay-transit-state
packet-encap-processing-state
qos-mpls-state
queues-state
sfm-state
spf-log-state
sr-state
sub-interface-statistics-state/bridge-domain-statistics
sub-interface-statistics-state/bridge-domain-statistics/lif-statistics
tm-state
topology-group-state
traffic-state
vc-peer-state
vpn-statistics-state
vxlan-acl-state/extended-data
Operations API
activate-status
bna-config-cmd
bna-config-cmd-status
clear-mpls-ldp-neighbor
clear-mpls-ldp-statistics
clear-mpls-lsp
clear-mpls-rsvp-statistics
clear-mpls-rsvp-statistics-neighbor
clear-mpls-statistics
clear-tm-voq-stat-ing-all-egr-all
clear-tm-voq-stat-ing-all-egr-ifname
clear-tm-voq-stat-slot-id-egr-all
clear-tm-voq-slot-id-egress-port-name
firmware-download
fwdl-status
get-arp
get-contained-in-ID
get-interface-detail
get-interface-switchport
get-ip-interface
get-last-config-update-time
get-last-config-update-time-for-xpaths
get-lldp-neighbor-detail
get-mac-acl-for-intf
get-mac-address-table
get-media-detail
get-maint-mode-status
get-netconf-client-capabilities
get-port-channel-detail
get-portchannel-info-by-intf
get-stp-brief-info
get-stp-mst-detail
get-system-uptime
get-tunnel-info
get-tunnel-statistics
get-vlan-brief
graceful-restart
mpls-reopt-lsp
optimized-replication
reload
set-http-application-url
show/selinux/status
show/snmp-server/status
show-clock
show-fabric-trunk-info
show-firmware-version
show-ntp
show-raslog
show-support-save-status
show-system-info
show-system-monitor
Overview of the SLX-OS REST API
