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

API Endpoints

afc.sites
afc.sites.fabrics
- Get Fabrics from Aruba Fabric Composer Site instance by UUIDget
afc.sites.refresh
- Refresh data learned from a Aruba Fabric Composer instance by UUIDpost
afc.sites.switches
- Get switches from a Aruba Fabric Composer instance by UUIDget
afc.sites.verify
- Verify connectivity of an Aruba Fabric Composer configuration by UUIDpost
afc.sites.vrfs
- Get VRF from a Aruba Fabric Composer instance by UUIDget
afc.sites.vsx
- Get vsxes from a Aruba Fabric Composer instance by UUIDget
applications
aruba.netedits
aruba.netedits.refresh
- Refresh data learned from a Aruba NetEdit instance by UUIDpost
aruba.netedits.verify
- Verify connectivity of an Aruba NetEdit configuration by UUIDpost
aspath_lists
aspath_lists.associate
- Associate AS Path List Configuration between switch scope and fabric scopepost
aspath_lists.aspath_list_entries
audits
- Get list of Audit Log objects in order from most recent to least recent.get
- Get an Audit Log by UUIDget
auth.password_policy
- Get the system password policyget
- Update the system password policyput
auth.sources
auth.sources.ldap
- Add a new LDAP authentication sourcepost
- Update a LDAP authentication source by UUIDput
auth.sources.ldap.verify
- Verify an existing LDAP authentication source by UUIDpost
auth.sources.pki
- Add a new PKI authentication sourcepost
- Update a PKI authentication source by UUIDput
auth.sources.pki.verify
- Verify an existing PKI authentication source by UUIDpost
auth.sources.radius
- Configure Radius for AFCpost
- Update a Radius config for AFCput
auth.sources.radius.verify
- Verify an existing RADIUS authentication source by UUIDpost
auth.token
- Delete an API access tokendelete
- Get an API access tokenpost
backups
backups.schedules
backups.upload
- Upload a backuppost
backups.restore
- Restore a backupput
certificates.ssl
- Get current Certificate Informationget
- Replace SSL/TLS Certificateput
certificates.ssl.regenerate
- Regenerate Self-Signed Certificatepost
clusters
- Get an array of clustersget
- Get a cluster by UUIDget
community_lists
community_lists.associate
- Associate Community List Configuration between switch scope and fabric scopepost
community_lists.community_list_entries
dhcp_relay
dns_client_configurations
endpoint_groups
evpn
evpn.evpn_routes
- Get a switches EVPN Routesget
evpn.multi_site
evpn.multi_site.reapply
- Reapply Fabric Wide stretch vlan configuration on border leader and Clear the stretch vlan and globacl setting configuration on older border leaderput
evpn.reapply
- Reapply Fabric Wide EVPN Configurationpost
evpn.settings
evpn.settings.switches
- Get an array of EVPN Switch Setings objectsget
fabrics
fabrics.l2_leaf_spine
fabrics.leaf_spine
fabrics.multi_hop_vxlan
fabrics.pvlans
fabrics.subleaf_leaf
fabrics.vsf
- Get an array of VSF stack peer objectsget
- Get a vsf object by UUIDget
fabrics.vsx
fabrics.vsxes.reapply
- Reapply VSX pair objectspost
fabrics.vxlan_tunnels
- Get an array of vxlan tunnel endpoint peer objectsget
fabrics.l2_leaf_spine.peers
fabrics.leaf_spine_workflow
- Add multiple leaf spine peer objectspost
- Reapply Leaf Spine Configurationput
fabrics.leaf_spine_workflow.settings
- Get leaf spine bulk settingsget
fabrics.subleaf_leaf.peers
fabrics.vsxes
- Add multiple VSX pair objectspost
fabrics.vsxes.merge
- Merge VSX pair objectsput
fabrics.vsxes.settings
- Get VSX bulk settingsget
fabrics.ospf_routers_summary
- Retrieve OSPF status summary for fabricget
firewall.log.client_configurations
firewall.profile.client_configurations
high_availability.api_state
- Get the API HA state.get
high_availability.config.reinit_replication
- Reinitialize configuration replication on a HA node.post
high_availability.config.status
- Get status of config replication on an HA cluster.get
high_availability.state
- Get the HA state for a service.get
high_availability.status
- Get cluster status objectget
high_availability.vips
hosts
hosts.vswitches
- Add a Distributed Virtual Switch(DVS)post
hosts.vswitches.add_hosts
- Add hosts to a Distributed Virtual Switch(DVS)post
hosts.vswitches.add_pvlan_vnics
- Add VM vnics to PVLAN Portgroups of Distributed Virtual Switch(DVS)post
hosts.vswitches.add_pvlans
- Add PVLANs to a Distributed Virtual Switch(DVS)post
hosts.vswitches.lags
- Add LAGs to a Distributed Virtual Switch(DVS)post
hpe.ilo_amplifiers
hpe.ilo_amplifiers.refresh
- Refresh data learned from Ilo Amplifier instance by UUIDpost
hpe.ilo_amplifiers.verify
- Verify connectivity of a HPE iLO Amplifier configuration by UUIDpost
hpe.simplivitys
hpe.simplivitys.refresh
- Refresh data learned from a HPE Simplivity instance by UUIDpost
hpe.simplivitys.verify
- Verify connectivity of a HPE Simplivity configuration by UUIDpost
integration_sets
- Get an array of integration setsget
- /integration_setspatch
integrations
- Get an array of integrationsget
lags
lags.merge
- Merge independent MLAG entities into MLAG pair entitiesput
lags.verify
- Verify the lldp neighbour information of portspost
licenses
licenses.check
- Get licenses check for requested count of licenses.get
licenses.status
- Get licenses statusget
mac_attachments
- Get a list of MAC attachments filtering output by query parameters.get
- Get MAC attachment by UUIDget
mac_attachments.refresh
- Refresh MAC attachments in persistent store.put
metric_collectors
- Get list of hosted metric collectorsget
- Get a specific metric collectorget
monitor_agents
monitor_agents.groups
neighbor_discovery.configurations
neighbor_discovery.neighbor.refresh
- Refresh neighbor discovery neighbors in persistent storeput
neighbor_discovery.neighbors
neighbor_discovery.statistics
- Get neighbor discovery statisticsget
networks
ntp_client_configurations
nutanix.prisms
nutanix.prisms.refresh
- Refresh data learned from a Nutanix Prism instance by UUIDpost
nutanix.prisms.verify
- Verify connectivity of a Nutanix Prism configuration by UUIDpost
openapi
- Get the Aruba Fabric Composer OpenAPI Schemaget
peers
- Get an array of Peer objectsget
pensando.alerts
- Get list of Pensando Alert objects in order from newest to oldest.get
- Get a Pensando Alert by UUIDget
pensando.dss
pensando.psms
pensando.psms.refresh
- Refresh data learned from a Pensando PSM instance by UUIDpost
pensando.psms.verify
- Verify connectivity of an Pensando PSM configuration by UUIDpost
ping
- Aruba Fabric Composer API status checkget
policies
policies.clone
- Clone Policy configurations by UUIDpost
policy_distribution_targets
policy_groups
ports
ports.dsm.statistics
- Get a list of Distributed Services Module Port statistic objectsget
- Get a Distributed Services Module Port's statisticsget
ports.statistics
- Get a list of port statistic objectsget
- Get a Port's statisticsget
prefix_lists
prefix_lists.associate
- Associate prefix List Configuration between switch scope and fabric scopepost
prefix_lists.prefix_list_entries
qualifiers
radius
remote_device_access
- Get Remote Device Access configuration.get
- Update Remote Device Access properties.put
remote_device_access.check_connection
- Run check connection command to specified target or defaults.post
resource_pool
route_maps
route_maps.associate
- Associate Route Map Configuration between switch scope and fabric scopepost
route_maps.route_map_entries
rules
rules.clone
- Clone Rule configurations by UUIDpost
settings
sflow_configurations
smart_nics
- Get an array of smart nic objectsget
- Get a smart nic by UUIDget
snmp_configurations
spanning_tree
spanning_tree.stp_configuration
spanning_tree.stp_instance_ports
- Get STP instance details.get
spanning_tree.stp_port_configuration
statistics.configuration.ports
support_bundles
switches
switches.checkpoint
switches.checkpoint.rollback
- Rollback a fabrics or switches to a checkpoint.post
switches.checkpoint.schedules
switches.checkpoint.snapshot
- Get metadata about a snapshotget
- Get metadata about a checkpoint snapshotget
switches.cli_commands
- CLI commands to switchespost
switches.cli_configs
- GET CLI configs from switchesget
- CLI configs to switchespost
switches.discover
- Discover switchespost
switches.downlink
switches.dsm
- Get an array of Distributed Services Module objects by switch uuidsget
- Get an array of Distributed Services Module objects by switch uuidget
switches.dsm.ports
- Get an array of Distributed Services Module Port objects by switch uuidsget
- Get an array of Distributed Services Module Port objects by switch uuidget
switches.dsm.statistics
switches.modules
switches.reboot
- Reboot switchesput
switches.reconcile
- Perform a soft config check on a list of switches.put
switches.save_config
- Perform a save config on a list of switches or fabrics.put
switches.software
- Get an array of switch software statesget
- Get a switch software state by UUIDget
switches.software.images
switches.software.stagings
switches.software.upgrades
switches.modules.reset
- Perform a reset on list of modules.put
switches.change_password
- Change the administrator password for a switchpost
switches.clear_password
- Clear the administrator password for a switchpost
syslog_client_configurations
system
- Get the system objectget
- Update the systemput
tags
tags.uuids
- Add a set of object UUIDs to the object type of the given tagpost
- Update (replace) the set of object UUIDs for the object type of the given tagput
transceivers
- Get an array of transceiver objects.get
users
users.current
- Get the current userget
users.current.change_password
- Change the password of the logged in userpost
users.current.update_preferences
- Update the preferences of the logged in userput
versions
- Get the Aruba Fabric Composer API and Software Versionsget
vlan_groups
vmware.nsxt
vmware.nsxt.refresh
- Refresh data learned from a VMware NSX-T instance by UUIDpost
vmware.nsxt.verify
- Verify connectivity of a VMware NSX-T configuration by UUIDpost
vmware.plugin.register
- Register the Aruba Fabric Composer vSphere Web Client Plugin with vCenterpost
vmware.sddcs
vmware.sddcs.refresh
- Refresh data learned from a VMWare SDDC instance by UUIDpost
vmware.sddcs.verify
- Verify connectivity of a VMWare SDDC configuration by UUIDpost
vmware.vcenters
vmware.vcenters.refresh
- Refresh data learned from a VMware vSphere instance by UUIDpost
vmware.vcenters.register
- Register the Aruba Fabric Composer vSphere Client Plugin by UUIDpost
vmware.vcenters.verify
- Verify connectivity of a VMware vSphere configuration by UUIDpost
vrfs
vrfs.reapply
- Re-apply VRFs to switchespost
vrfs.bgp
vrfs.bgp.status
- Retrieve VRF's BGP stateget
vrfs.bgp.summary
- Retrieve VRF's BGP summaryget
vrfs.ip_interfaces
vrfs.ip_interfaces.status
- Retrieve VRF's IP Interfaces stateget
vrfs.ip_static_routes
vrfs.ip_tables.arp
- Get ARP table for VRF switchget
vrfs.ip_tables.ip_route
- Get IP routes for VRF switchget
vrfs.networks
vrfs.ospf_global
- Retrieve the OSPF global configuration for a virtual routing forwardingget
- Update OSPF global configuration for a virtual routing forwardingput
vrfs.ospf_neighbors.status
- Retrieve all OSPF neighbors status for a virtual routing forwardingget
vrfs.ospf_routers
vrfs.ospf_routers.summary
- Retrieve VRF's OSPF status summaryget
vrfs.ospf_routers.areas
vrfs.ospf_routers.areas.interfaces
vrfs.ospf_routers.areas.interfaces.status
- Retrieve OSPF interface status for a virtual routing forwardingget
vrfs.ospf_routers.areas.ranges
vrfs.ospf_routers.areas.vlinks
vrfs.ospf_routers.summary_addresses
vrfs.overlay
vrfs.switches
vrfs.underlay

API Endpoints

afc.sites
afc.sites.fabrics
- Get Fabrics from Aruba Fabric Composer Site instance by UUIDget
afc.sites.refresh
- Refresh data learned from a Aruba Fabric Composer instance by UUIDpost
afc.sites.switches
- Get switches from a Aruba Fabric Composer instance by UUIDget
afc.sites.verify
- Verify connectivity of an Aruba Fabric Composer configuration by UUIDpost
afc.sites.vrfs
- Get VRF from a Aruba Fabric Composer instance by UUIDget
afc.sites.vsx
- Get vsxes from a Aruba Fabric Composer instance by UUIDget
applications
aruba.netedits
aruba.netedits.refresh
- Refresh data learned from a Aruba NetEdit instance by UUIDpost
aruba.netedits.verify
- Verify connectivity of an Aruba NetEdit configuration by UUIDpost
aspath_lists
aspath_lists.associate
- Associate AS Path List Configuration between switch scope and fabric scopepost
aspath_lists.aspath_list_entries
audits
- Get list of Audit Log objects in order from most recent to least recent.get
- Get an Audit Log by UUIDget
auth.password_policy
- Get the system password policyget
- Update the system password policyput
auth.sources
auth.sources.ldap
- Add a new LDAP authentication sourcepost
- Update a LDAP authentication source by UUIDput
auth.sources.ldap.verify
- Verify an existing LDAP authentication source by UUIDpost
auth.sources.pki
- Add a new PKI authentication sourcepost
- Update a PKI authentication source by UUIDput
auth.sources.pki.verify
- Verify an existing PKI authentication source by UUIDpost
auth.sources.radius
- Configure Radius for AFCpost
- Update a Radius config for AFCput
auth.sources.radius.verify
- Verify an existing RADIUS authentication source by UUIDpost
auth.token
- Delete an API access tokendelete
- Get an API access tokenpost
backups
backups.schedules
backups.upload
- Upload a backuppost
backups.restore
- Restore a backupput
certificates.ssl
- Get current Certificate Informationget
- Replace SSL/TLS Certificateput
certificates.ssl.regenerate
- Regenerate Self-Signed Certificatepost
clusters
- Get an array of clustersget
- Get a cluster by UUIDget
community_lists
community_lists.associate
- Associate Community List Configuration between switch scope and fabric scopepost
community_lists.community_list_entries
dhcp_relay
dns_client_configurations
endpoint_groups
evpn
evpn.evpn_routes
- Get a switches EVPN Routesget
evpn.multi_site
evpn.multi_site.reapply
- Reapply Fabric Wide stretch vlan configuration on border leader and Clear the stretch vlan and globacl setting configuration on older border leaderput
evpn.reapply
- Reapply Fabric Wide EVPN Configurationpost
evpn.settings
evpn.settings.switches
- Get an array of EVPN Switch Setings objectsget
fabrics
fabrics.l2_leaf_spine
fabrics.leaf_spine
fabrics.multi_hop_vxlan
fabrics.pvlans
fabrics.subleaf_leaf
fabrics.vsf
- Get an array of VSF stack peer objectsget
- Get a vsf object by UUIDget
fabrics.vsx
fabrics.vsxes.reapply
- Reapply VSX pair objectspost
fabrics.vxlan_tunnels
- Get an array of vxlan tunnel endpoint peer objectsget
fabrics.l2_leaf_spine.peers
fabrics.leaf_spine_workflow
- Add multiple leaf spine peer objectspost
- Reapply Leaf Spine Configurationput
fabrics.leaf_spine_workflow.settings
- Get leaf spine bulk settingsget
fabrics.subleaf_leaf.peers
fabrics.vsxes
- Add multiple VSX pair objectspost
fabrics.vsxes.merge
- Merge VSX pair objectsput
fabrics.vsxes.settings
- Get VSX bulk settingsget
fabrics.ospf_routers_summary
- Retrieve OSPF status summary for fabricget
firewall.log.client_configurations
firewall.profile.client_configurations
high_availability.api_state
- Get the API HA state.get
high_availability.config.reinit_replication
- Reinitialize configuration replication on a HA node.post
high_availability.config.status
- Get status of config replication on an HA cluster.get
high_availability.state
- Get the HA state for a service.get
high_availability.status
- Get cluster status objectget
high_availability.vips
hosts
hosts.vswitches
- Add a Distributed Virtual Switch(DVS)post
hosts.vswitches.add_hosts
- Add hosts to a Distributed Virtual Switch(DVS)post
hosts.vswitches.add_pvlan_vnics
- Add VM vnics to PVLAN Portgroups of Distributed Virtual Switch(DVS)post
hosts.vswitches.add_pvlans
- Add PVLANs to a Distributed Virtual Switch(DVS)post
hosts.vswitches.lags
- Add LAGs to a Distributed Virtual Switch(DVS)post
hpe.ilo_amplifiers
hpe.ilo_amplifiers.refresh
- Refresh data learned from Ilo Amplifier instance by UUIDpost
hpe.ilo_amplifiers.verify
- Verify connectivity of a HPE iLO Amplifier configuration by UUIDpost
hpe.simplivitys
hpe.simplivitys.refresh
- Refresh data learned from a HPE Simplivity instance by UUIDpost
hpe.simplivitys.verify
- Verify connectivity of a HPE Simplivity configuration by UUIDpost
integration_sets
- Get an array of integration setsget
- /integration_setspatch
integrations
- Get an array of integrationsget
lags
lags.merge
- Merge independent MLAG entities into MLAG pair entitiesput
lags.verify
- Verify the lldp neighbour information of portspost
licenses
licenses.check
- Get licenses check for requested count of licenses.get
licenses.status
- Get licenses statusget
mac_attachments
- Get a list of MAC attachments filtering output by query parameters.get
- Get MAC attachment by UUIDget
mac_attachments.refresh
- Refresh MAC attachments in persistent store.put
metric_collectors
- Get list of hosted metric collectorsget
- Get a specific metric collectorget
monitor_agents
monitor_agents.groups
neighbor_discovery.configurations
neighbor_discovery.neighbor.refresh
- Refresh neighbor discovery neighbors in persistent storeput
neighbor_discovery.neighbors
neighbor_discovery.statistics
- Get neighbor discovery statisticsget
networks
ntp_client_configurations
nutanix.prisms
nutanix.prisms.refresh
- Refresh data learned from a Nutanix Prism instance by UUIDpost
nutanix.prisms.verify
- Verify connectivity of a Nutanix Prism configuration by UUIDpost
openapi
- Get the Aruba Fabric Composer OpenAPI Schemaget
peers
- Get an array of Peer objectsget
pensando.alerts
- Get list of Pensando Alert objects in order from newest to oldest.get
- Get a Pensando Alert by UUIDget
pensando.dss
pensando.psms
pensando.psms.refresh
- Refresh data learned from a Pensando PSM instance by UUIDpost
pensando.psms.verify
- Verify connectivity of an Pensando PSM configuration by UUIDpost
ping
- Aruba Fabric Composer API status checkget
policies
policies.clone
- Clone Policy configurations by UUIDpost
policy_distribution_targets
policy_groups
ports
ports.dsm.statistics
- Get a list of Distributed Services Module Port statistic objectsget
- Get a Distributed Services Module Port's statisticsget
ports.statistics
- Get a list of port statistic objectsget
- Get a Port's statisticsget
prefix_lists
prefix_lists.associate
- Associate prefix List Configuration between switch scope and fabric scopepost
prefix_lists.prefix_list_entries
qualifiers
radius
remote_device_access
- Get Remote Device Access configuration.get
- Update Remote Device Access properties.put
remote_device_access.check_connection
- Run check connection command to specified target or defaults.post
resource_pool
route_maps
route_maps.associate
- Associate Route Map Configuration between switch scope and fabric scopepost
route_maps.route_map_entries
rules
rules.clone
- Clone Rule configurations by UUIDpost
settings
sflow_configurations
smart_nics
- Get an array of smart nic objectsget
- Get a smart nic by UUIDget
snmp_configurations
spanning_tree
spanning_tree.stp_configuration
spanning_tree.stp_instance_ports
- Get STP instance details.get
spanning_tree.stp_port_configuration
statistics.configuration.ports
support_bundles
switches
switches.checkpoint
switches.checkpoint.rollback
- Rollback a fabrics or switches to a checkpoint.post
switches.checkpoint.schedules
switches.checkpoint.snapshot
- Get metadata about a snapshotget
- Get metadata about a checkpoint snapshotget
switches.cli_commands
- CLI commands to switchespost
switches.cli_configs
- GET CLI configs from switchesget
- CLI configs to switchespost
switches.discover
- Discover switchespost
switches.downlink
switches.dsm
- Get an array of Distributed Services Module objects by switch uuidsget
- Get an array of Distributed Services Module objects by switch uuidget
switches.dsm.ports
- Get an array of Distributed Services Module Port objects by switch uuidsget
- Get an array of Distributed Services Module Port objects by switch uuidget
switches.dsm.statistics
switches.modules
switches.reboot
- Reboot switchesput
switches.reconcile
- Perform a soft config check on a list of switches.put
switches.save_config
- Perform a save config on a list of switches or fabrics.put
switches.software
- Get an array of switch software statesget
- Get a switch software state by UUIDget
switches.software.images
switches.software.stagings
switches.software.upgrades
switches.modules.reset
- Perform a reset on list of modules.put
switches.change_password
- Change the administrator password for a switchpost
switches.clear_password
- Clear the administrator password for a switchpost
syslog_client_configurations
system
- Get the system objectget
- Update the systemput
tags
tags.uuids
- Add a set of object UUIDs to the object type of the given tagpost
- Update (replace) the set of object UUIDs for the object type of the given tagput
transceivers
- Get an array of transceiver objects.get
users
users.current
- Get the current userget
users.current.change_password
- Change the password of the logged in userpost
users.current.update_preferences
- Update the preferences of the logged in userput
versions
- Get the Aruba Fabric Composer API and Software Versionsget
vlan_groups
vmware.nsxt
vmware.nsxt.refresh
- Refresh data learned from a VMware NSX-T instance by UUIDpost
vmware.nsxt.verify
- Verify connectivity of a VMware NSX-T configuration by UUIDpost
vmware.plugin.register
- Register the Aruba Fabric Composer vSphere Web Client Plugin with vCenterpost
vmware.sddcs
vmware.sddcs.refresh
- Refresh data learned from a VMWare SDDC instance by UUIDpost
vmware.sddcs.verify
- Verify connectivity of a VMWare SDDC configuration by UUIDpost
vmware.vcenters
vmware.vcenters.refresh
- Refresh data learned from a VMware vSphere instance by UUIDpost
vmware.vcenters.register
- Register the Aruba Fabric Composer vSphere Client Plugin by UUIDpost
vmware.vcenters.verify
- Verify connectivity of a VMware vSphere configuration by UUIDpost
vrfs
vrfs.reapply
- Re-apply VRFs to switchespost
vrfs.bgp
vrfs.bgp.status
- Retrieve VRF's BGP stateget
vrfs.bgp.summary
- Retrieve VRF's BGP summaryget
vrfs.ip_interfaces
vrfs.ip_interfaces.status
- Retrieve VRF's IP Interfaces stateget
vrfs.ip_static_routes
vrfs.ip_tables.arp
- Get ARP table for VRF switchget
vrfs.ip_tables.ip_route
- Get IP routes for VRF switchget
vrfs.networks
vrfs.ospf_global
- Retrieve the OSPF global configuration for a virtual routing forwardingget
- Update OSPF global configuration for a virtual routing forwardingput
vrfs.ospf_neighbors.status
- Retrieve all OSPF neighbors status for a virtual routing forwardingget
vrfs.ospf_routers
vrfs.ospf_routers.summary
- Retrieve VRF's OSPF status summaryget
vrfs.ospf_routers.areas
vrfs.ospf_routers.areas.interfaces
vrfs.ospf_routers.areas.interfaces.status
- Retrieve OSPF interface status for a virtual routing forwardingget
vrfs.ospf_routers.areas.ranges
vrfs.ospf_routers.areas.vlinks
vrfs.ospf_routers.summary_addresses
vrfs.overlay
vrfs.switches
vrfs.underlay

Change the administrator password for a switch

post https://example.com/api/switches/{uuid}/change_password

Language

Credentials

Header

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

Terms of Service

© Copyright 2024 Hewlett Packard Enterprise Development LP