Jump to Content
API Reference
New Central
Guides
MRT API
Configuration API
AOS 8
AOS-CX
Central
New Central
New Central - Configuration API
ClearPass Policy Manager
User Experience Insight
Fabric Composer
EdgeConnect SD-WAN
Github
Airheads Developer Community
API Reference
Github
Airheads Developer Community
New Central - Configuration API
API Reference
New Central
Guides
MRT API
Configuration API
Read rip
JUMP TO
Scope Management
Device Groups
Get device-groups
get
Create device-group
post
Update device-group
put
Add devices to device-group
post
Create device-group with devices
post
Remove devices from device-group
post
Bulk delete device-groups
del
Add devices to device-collection
post
Create device-collection with devices
post
Remove devices from device-collection
post
Delete device-collection by scopeId
del
Get device-collections
get
Create device-collection
post
Update device-collection
put
Bulk delete device-collections
del
Get device-groups
get
Create device-group
post
Update device-group
put
Add devices to device-group
post
Create device-group with devices
post
Remove devices from device-group
post
Bulk delete device-groups
del
Hierarchy
Get scope hierarchy
get
Get scope hierarchy
get
Site Collections
Add sites to existing site-collection
post
Remove sites from site-collection
del
Get site-collections
get
Create site-collection
post
Update site-collection
put
Bulk delete site-collections
del
Add sites to existing site-collection
post
Remove sites from site-collection
del
Delete site-collection by scopeId
del
Get site-collections
get
Create site-collection
post
Update site-collection
put
Bulk delete site-collections
del
Sites
Add devices to site
post
Get sites
get
Create site
post
Update site
put
Bulk delete sites
del
Add devices to site
post
Delete site by scopeId
del
Get sites
get
Create site
post
Update site
put
Bulk delete sites
del
Application Experience
App Recog Control
Read existing ARC Configuration
get
Delete ARC profile of {name}
del
Read existing ARC profile of {name}
get
Update existing ARC profile of {name}
patch
Create new ARC profile of {name}
post
Central NAC
Cda Identity Store
Read identity stores configuration(s).
get
Delete identity store configuration.
del
Read identity store configuration.
get
Update identity store configuration.
patch
Create identity store configuration.
post
Cda Portal Overrides Profile
Read portal overrides profiles
get
Delete a portal overrides profile
del
Read a portal overrides profile
get
Update a portal overrides profile
patch
Create a portal overrides profile
post
Cda Portal Profile
Read portal profiles
get
Delete a portal profile
del
Read a portal profile
get
Update a portal profile
patch
Create a portal profile
post
Cda Airpass Approval
Read Air Pass profile configuration(s).
get
Read authentication approval configuration.
get
Cda Authz Policy
Read authorization policy configuration(s).
get
Delete authorization policy configuration.
del
Read authorization policy configuration.
get
Update authorization policy configuration.
patch
Create authorization policy configuration.
post
Cda Message Provider
Read message provider profiles
get
Delete a message provider profile
del
Read a message provider profile
get
Update a message provider profile
patch
Create a message provider profile
post
Cda Auth Profile
Read authentication profile configuration(s).
get
Delete authentication profile configuration.
del
Read authentication profile configuration.
get
Update authentication profile configuration.
patch
Create authentication profile configuration.
post
Cda Portal Skin Profile
Read portal skin profiles
get
Delete a portal skin profile
del
Read a portal skin profile
get
Update a portal skin profile
patch
Create a portal skin profile
post
Central NAC Service
MAC Registration
List MAC registrations
get
Add MAC registration
post
Update MAC registration
put
Export MAC csv file
get
Import MAC csv file
post
Delete MAC registration
del
MPSK Registration
List Named MPSK registrations
get
Add Named MPSK registration
post
Update Named MPSK registration
put
Export Named MPSK csv file
get
Import Named MPSK csv file
post
Delete Named MPSK registration
del
Visitor
List visitor accounts
get
Add visitor account
post
Update visitor account
put
Export visitor csv file
get
Delete visitor account
del
Job
List jobs
get
Terminate job
del
Download result file
get
Download error file
get
Download input file
get
Get job status
get
Image
List images
get
Download image file
get
Upload image file
post
Get image details
get
User Certificate
List user certificates
get
Revoke user certificates
post
DPP Registration
List DPP registrations
get
Add DPP registration
post
Update DPP registration
put
Delete DPP registration
del
Get a DPP registration
get
Config Management
Config Checkpoint
Read configuration checkpoint profiles
get
Delete existing Checkpoint configuration profile
del
Read existing Checkpoint configuration profile
get
Update existing Checkpoint configuration profile
patch
Create new Checkpoint configuration profile
post
Persona Assignment
Assign device function to a list of devices.
post
Persona Mapping
Get list of device types and their corresponding supported device functions.
get
Get list of device functions supported by device type.
get
Configuration Health
Configuration Health
Returns active configuration issues for a device.
get
Returns summary of configuration health for devices.
get
High Availability
Switch Stack
Read configured stacks
get
Delete the stack
del
Read existing stack configurations
get
Update existing stack configurations
patch
Create a new stack by unique name
post
Vsx
Read vsx profiles
get
Delete vsx by name
del
Read vsx by name
get
Update vsx by name
patch
Create vsx by name
post
Gw Cluster
Read the configured Gateway Cluster Profiles
get
Delete a gateway cluster profile
del
Read an existing gateway cluster profile configuration
get
Update an existing gateway cluster profile configuration
patch
Create a gateway cluster profile configuration
post
Extensions
Extension Vsphere
Read vsphere-instances
get
Delete vsphere-instance by name
del
Read vsphere-instance by name
get
Update vsphere-instance by name
patch
Create vsphere-instance by name
post
Firmware Policy
Firmware Compliance
Delete firmware policy configuration.
del
Read firmware policy configuration.
get
Update firmware policy configuration.
patch
Create firmware policy configuration.
post
Gateway Clustering Orchestration
Gw Cluster Intent
Read gw-cluster-intent-config
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Interfaces
Dhcp Client
Read DHCP Client configurations
get
Delete profile for DHCP Client configurations
del
Read profile for DHCP Client configurations
get
Update profile for DHCP Client configurations
patch
Create profile for DHCP Client configurations
post
Mirror
Read configured mirror sessions.
get
Delete mirror session associated with profile.
del
Read configured mirror session associated with profile.
get
Update profile by name
patch
Create mirror session using profile.
post
Interface Subinterface
Read sub-interface(s) configurations
get
Delete sub-interface configurations
del
Read sub-interface configurations
get
Update sub-interface configurations
patch
Create sub-interface configurations
post
Lacp
Delete existing LACP configuration at the system level
del
Read existing configuration at the system level
get
Modify LACP configuration at the system level
patch
Create LACP configuration at the system level
post
Interface Loopback
Read loopback interface(s) configurations
get
Delete loopback interface configurations
del
Read loopback interface configurations
get
Update loopback interface configurations
patch
Create loopback interface configurations
post
Lldp
Read existing LLDP configuration.
get
Delete LLDP configuration for given name.
del
Read existing LLDP configuration for given name.
get
Update existing LLDP configuration for given name.
patch
Configure LLDP by unique name.
post
Static Mac
Read Static MAC profiles.
get
Delete associated Static MACs & their configuration.
del
Read associated Static MACs & their configuration.
get
Update profile by name
patch
Add Static MAC addresses with associated VLAN and port.
post
Interface Ethernet
Read interface(s) configurations
get
Read interface configurations
get
Update interface configurations
patch
Create interface configurations
post
Interface Vlan
Read VLAN interface(s) configurations
get
Delete VLAN interface configurations
del
Read VLAN interface configurations
get
Update VLAN interface configurations
patch
Create VLAN interface configurations
post
Sw Port Profile
Read configured switch port profiles
get
Delete the switch port profile
del
Read existing switch port profile configurations
get
Update existing switch port profile configurations
patch
Create a new switch port profile by unique name
post
Ap Port Profile
Read configured port profiles
get
Delete the port profile
del
Read existing port profile configuration
get
Update profile by profile-name
patch
Create a new port profile by unique name
post
Ufd
Read existing UFD Configuration.
get
Delete UFD configurations for given name.
del
Read existing UFD Configuration for given name.
get
Update existing UFD configurations for given name.
patch
Configure UFD by unique name.
post
Interface Management
Read Management interface configurations
get
Delete profile for Management interface configurations
del
Read profile for Management interface configurations
get
Update profile for Management interface configurations
patch
Create profile for Management interface configurations
post
Ap Uplink
Read existing uplink parameters
get
Delete the uplink profile
del
Read the existing uplink profile
get
Update profile by name
patch
Create an uplink profile
post
Cdp
Read existing CDP configuration.
get
Delete CDP configuration for given name.
del
Read existing CDP configuration for given name.
get
Update existing CDP configuration for given name.
patch
Configure CDP by unique name.
post
Fault Monitor
Read configured fault monitor profiles
get
Delete the fault monitor profile
del
Read existing fault monitor profile configurations
get
Update the existing fault monitor profile configurations
patch
Create a new fault monitor profile by unique name
post
Mirror Endpoint
Read configured mirror-endpoints.
get
Delete all mirror-endpoints associated with profile.
del
Read configured mirror-endpoints associated with profile.
get
Update profile by name
patch
Create/update mirror-endpoints and associated them with profile. This wraps one or more mirror-endpoints within the context of a profile.
post
Interface Portchannel
Read port channel(s) interface configurations
get
Delete port channel interface configurations
del
Read port channel interface configurations
get
Update port channel interface configurations
patch
Create port channel interface configurations
post
Device Profile
Read Device-Profile configuration.
get
Delete existing Device-Profile.
del
Read existing Device-Profile configuration.
get
Update existing Device-Profile configuration.
patch
Configure a new Device-Profile.
post
Sflow
Read configured sFlow Configuration
get
Delete sFlow configurations.
del
Read existing sFlow Configuration.
get
Update existing sFlow configurations.
patch
Configure sFlow by unique name.
post
Gw Port Profile
Read configured gateway port profiles
get
Delete the gateway port profile
del
Read existing gateway port profile configurations
get
Update existing gateway port profile configurations
patch
Create a new gateway port profile by unique name
post
Interface Profile
Read existing Interface Profile Configuration.
get
Delete Interface Profile configurations for given name.
del
Read existing Interface Profile Configuration for given name.
get
Update existing Interface Profile configurations for given name.
patch
Configure Interface Profile by unique name.
post
Interface
Device Profile
Read Device-Profile configuration.
get
Configure a new Device-Profile.
post
Read existing Device-Profile configuration.
get
Update existing Device-Profile configuration.
patch
Delete existing Device-Profile.
del
Interface Security
Mac Lockout
Read mac lockout profiles
get
Create a new mac lockout profile by unique name
post
Read existing mac lockout profile configurations
get
Update existing mac lockout profile configurations
patch
Delete mac lockout profile
del
Macsec
Read MACsec configuration
get
Configure a new MACsec policy
post
Read existing MACsec policy
get
Update existing MACsec policy
patch
Delete existing MACsec policy
del
IoT
Usb
Read configured usb parameters
get
Delete the usb configuration
del
Read existing usb configuration configurations
get
Update profile by name
patch
Create a new usb configuration by unique name
post
Miscellaneous
Overlay Wlan
Read overlay-wlan
get
Delete ssid-cluster by profile
del
Read ssid-cluster by profile
get
Update ssid-cluster by profile
patch
Create ssid-cluster by profile
post
Extension Splunk
Read splunk-instances
get
Delete instance by name
del
Read instance by name
get
Update instance by name
patch
Create instance by name
post
Named Object
Net Service
Read Net Services configuration
get
Delete Net Service configuration
del
Read Net Service configuration
get
Update existing Net Service configuration
patch
Add Net Service configuration
post
Alias
Read aliases
get
Delete alias by name
del
Read alias by name
get
Update alias by name
patch
Create alias by name
post
Network Services
Ipsla
Read ipsla
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Nd Snooping Interface
Read existing ND-Snooping interface configuration
get
Delete the profile for ND-Snooping interface configuration
del
Read configured profile for ND-Snooping interface configuration
get
Update existing ND-Snooping interface configuration profile configuration
patch
Create new profile for ND-Snooping interface configuration
post
Multicast Dns
Read existing Multicast DNS configurations
get
Delete the profile for Multicast DNS
del
Read configured profile for Multicast DNS
get
Update existing Multicast DNS profile configurations
patch
Create profile name for Multicast DNS
post
Dhcp Server
Read DHCPv4/DHCPv6 Server configurations
get
Delete profile for DHCPv4/DHCPv6 Server configurations
del
Read profile for DHCPv4/DHCPv6 Server configurations
get
Update profile for DHCPv4/DHCPv6 Server configurations
patch
Create profile for DHCPv4/DHCPv6 Server configurations
post
Nd Snooping
Read existing ND-Snooping configuration
get
Delete the profile for ND-Snooping
del
Read configured profile for ND-Snooping
get
Update existing ND-Snooping profile configuration
patch
Create new profile for ND-Snooping
post
Ip Lockdown Interface
Read existing IP source lockdown interface configuration
get
Delete IP source lockdown interface profile
del
Read existing IP source lockdown interface profile
get
Update existing IP source lockdown interface profile
patch
Create new IP source lockdown interface profile
post
Qos Queue
Read QoS queue profiles
get
Delete the QoS queue profile
del
Read existing QoS queue profile configurations
get
Update existing QoS queue profile configurations
patch
Create a new QoS queue profile with unique name
post
Dhcp Snooping Interface
Read existing DHCP-Snooping interface configuration
get
Delete the profile for DHCP-Snooping interface configuration
del
Read configured profile for DHCP-Snooping interface configuration
get
Update existing DHCP-Snooping interface configuration profile configuration
patch
Create new profile for DHCP-Snooping interface configuration
post
Dhcp Snooping
Read existing DHCP-Snooping configuration
get
Delete the profile for DHCP-Snooping
del
Read configured profile for DHCP-Snooping
get
Update existing DHCP-Snooping profile configuration
patch
Create new profile for DHCP-Snooping
post
Dynamic Arp Inspection Interface
Read existing Dynamic ARP Inspection interface configuration
get
Delete the profile for Dynamic ARP Inspection interface configuration
del
Read configured profile for Dynamic ARP Inspection interface configuration
get
Update existing Dynamic ARP Inspection interface configuration profile configuration
patch
Create new profile for Dynamic ARP Inspection interface configuration
post
Dhcp Relay
Read DHCPv4/DHCPv6 Relay configurations
get
Delete profile for DHCPv4/DHCPv6 Relay configurations
del
Read profile for DHCPv4/DHCPv6 Relay configurations
get
Update profile for DHCPv4/DHCPv6 Relay configurations
patch
Create profile for DHCPv4/DHCPv6 Relay configurations
post
Qos Global
Read Global QoS parameters
get
Delete the Global QoS profile
del
Read existing Global QoS profile configurations
get
Update existing Global QoS profile configurations
patch
Create a new Global QoS profile with unique name
post
Ip Binding
Read existing source ip binding configuration
get
Delete static entry configuration
del
Read existing static entry configuration
get
Update existing static entry configuration
patch
Create new static entry configuration
post
External Storage
Read External Storage configurations
get
Delete profile for External Storage configurations
del
Read profile for External Storage configurations
get
Update profile for External Storage configurations
patch
Create profile for External Storage configurations
post
Qos Schedule
Read QoS schedule profiles
get
Delete the QoS schedule-profile
del
Read existing QoS schedule-profile configurations
get
Update existing QoS schedule-profile configurations
patch
Create a new QoS schedule-profile with unique name
post
Mgmd
Read existing Multicast Group Membership Discovery Protocol configurations
get
Delete the profile for MGMD
del
Read configured profile for MGMD
get
Update existing MGMD profile configurations
patch
Create profile for MGMD
post
Nae Lite
Read existing nae-lite agent configurations
get
Delete the nae-lite agent
del
Read existing nae-lite agent configurations
get
Update existing nae-lite agent configurations
patch
Create a new nae-lite agent by unique name
post
Udp Broadcast Forwarder
Read UDP Broadcast Forwarder configurations
get
Delete profile for UDP Broadcast Forwarder configurations
del
Read profile for UDP Broadcast Forwarder configurations
get
Update profile for UDP Broadcast Forwarder configurations
patch
Create profile for UDP Broadcast Forwarder configurations
post
Ip Lockdown
Read existing IP source lockdown configuration
get
Delete IP source lockdown profile
del
Read existing IP source lockdown profile
get
Update existing IP source lockdown profile
patch
Create new IP source lockdown profile
post
Dhcp Pool
Read dhcp-pool
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Qos Threshold Profile
Read QoS threshold profile parameters
get
Delete the QoS threshold profile
del
Read existing QoS threshold profile configurations
get
Update existing QoS threshold profile configurations
patch
Create a new QoS threshold profile by unique name
post
Roles & Policy
Object Group
Read Object Groups
get
Delete Object Group
del
Read Object Group
get
Update Object Group
patch
Add Object Group
post
Policy Group
Delete policy-groups
del
Read policy-groups
get
Update policy-groups
patch
Create policy-groups
post
Role
Read existing roles
get
Delete the role
del
Read the existing role configuration
get
Update role
patch
Create a role by unique name
post
Role Acl
Read Role ACLs
get
Delete Role ACL
del
Read Role ACL
get
Update Role ACL
patch
Add Role ACL
post
Role Gpid
Read existing roles
get
Delete the role
del
Read the existing role configuration
get
Update role
patch
Create a role with gpid
post
Policy
Read existing policies
get
Delete the policy
del
Read the existing policy configuration
get
Update policy by name
patch
Create a policy by unique name
post
Routing & Overlays
Track Object
Read tracking-object
get
Delete vrrp by identifier
del
Read vrrp by identifier
get
Update vrrp by identifier
patch
Create vrrp by identifier
post
Ospfv2
Read ospfv2
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Ip Routing
Read ip-routing
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Multicast Static Route
Read existing Multicast Static Route configurations
get
Delete the profile for Multicast Static Route
del
Read configured profile for Multicast Static Route
get
Update existing Multicast Static Route profile configurations
patch
Create profile for Multicast Static Route
post
Bfd
Read bfd
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Aspath List
Read existing aspath-list configuration
get
Delete as-path-list with name {aspathListName}
del
Read existing as-path-list with name {aspathListName}
get
Update existing as-path-list with name {aspathListName}
patch
Create new as-path-list with name {aspathListName}
post
Ospfv3
Read ospfv3
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Community List
Read existing community-list configuration
get
Delete community-list by community-list-name-community-type
del
Read community-list by community-list-name-community-type
get
Update community-list by community-list-name-community-type
patch
Create community-list by community-list-name-community-type
post
Vrf
Read existing VRFs
get
Delete VRF {name}
del
Read configuration for existing VRF {name}
get
Update configuration for existing VRF {name}
patch
Create new VRF {name}
post
Multicast
Read existing Multicast Protocol configurations
get
Delete the profile for Multicast
del
Read configured profile for Multicast
get
Update existing Multicast profile configurations
patch
Create profile name for Multicast
post
Pim
Read existing Protocol Independent Multicast configurations
get
Delete the profile for PIM
del
Read configured profile for PIM
get
Update existing PIM profile configurations
patch
Create profile name for PIM
post
Rip
Read rip
get
Delete a RIP profile
del
Read an existing RIP profile
get
Update an existing RIP profile
patch
Create a RIP profile
post
Evpn
Read existing EVPN configuration
get
Delete EVPN profile {name}
del
Read existing EVPN profile {name}
get
Update existing configuration EVPN profile {name}
patch
Create new EVPN profile {name}
post
Static Route
Read static-route
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Routemap
Read existing route-map configuration
get
Delete route-map with name {name}
del
Read existing route-map with name {name}
get
Update existing route-map with name {name}
patch
Create new route-map with name {name}
post
Msdp
Read existing Multicast Source Discovery Protocol configurations
get
Delete the profile for MSDP
del
Read configured profile for MSDP
get
Update existing MSDP profile configurations
patch
Create profile name for MSDP
post
Prefix List
Read existing prefix-list configuration
get
Delete prefix-list with name {prefixListName} under address-family {AddressFamily}
del
Read existing prefix-list with name {prefixListName} under address-family {AddressFamily}
get
Update existing prefix-list with name {prefixListName} under address-family {AddressFamily}
patch
Create new prefix-list with name {prefixListName} under address-family {AddressFamily}
post
L3 Route
Read l3-route
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Bgp
Read existing BGP router configuration
get
Delete BGP profile.
del
Read existing BGP profile.
get
Update profile by name
patch
Create BGP profile.
post
Security
Gw Certificate Usage
Read the configured Gateway-Certificate-Usage Profile
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Passpoint Identity
Read existing ANQP NAI Realm related settings.
get
Delete ANQP NAI Realm profile.
del
Read existing ANQP NAI Realm profile.
get
Update profile by name
patch
Create ANQP NAI Realm profile.
post
Auth Server Global
Read configuration of Auth Server Global
get
Delete the profile for Auth Server Global
del
Read configured profile for Auth Server Global
get
Update existing Auth Server Global profile configurations
patch
Create profile name for Auth Server Global
post
Certificate Rcp
Read certificate-rcp
get
Delete ta-profile by name
del
Read ta-profile by name
get
Update ta-profile by name
patch
Create ta-profile by name
post
Aaa Dot1xsupp
Read dot1xsupp
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Aaa Dot1xauth
Read existing 802.1X authentication configuration
get
Delete an existing 802.1X authentication profile
del
Read an existing 802.1X authentication profile
get
Update an existing 802.1X authentication profile
patch
Configure a new 802.1X authentication profile.
post
Aaa Captive Portal
Read configuration of external captive portal
get
Delete the external captive profile
del
Read existing external captive profile configuration
get
Update existing external captive profile configuration
patch
Create a new external captive profile by unique name
post
Ap Certificate Usage
Read configuration of AP certificate usage
get
Delete the AP certificate usage profile
del
Read existing AP certificate usage profile configurations
get
Update existing AP certificate usage profile configurations
patch
Create an AP certificate usage profile by unique name
post
Auth Server
Read configuration of auth server profile
get
Delete the auth server profile
del
Read existing auth server profile configuration
get
Update existing auth server profile configuration
patch
Create a new auth server profile by unique name
post
Aaa Profile
Read an existing AAA profile
get
Delete an exiting AAA profile
del
Read an exiting AAA profile
get
Update an exiting AAA profile
patch
Configure a new AAA profile
post
Radius Modifiers
Read configuration of Radius modifier
get
Delete the Radius modifier profile
del
Read existing Radius modifier profile configuration
get
Update existing Radius modifier profile configuration
patch
Create a new Radius modifier profile by unique name
post
Certificate Store
Read certificate-store
get
Delete certificate by name
del
Read certificate by name
get
Update certificate by name
patch
Create certificate by name
post
802dot11k Rrm Ie
Read existing RRM-IE related setting.
get
Delete RRM-IE profile.
del
Read existing RRM-IE profile.
get
Update profile by name
patch
Create RRM-IE profile.
post
Firewall
Read configured firewall Profile
get
Delete the firewall profile
del
Read existing firewall configuration
get
Update existing firewall configurations
patch
Create firewall Profile
post
Ubt
Read configured UBT profiles
get
Delete the UBT profile
del
Read existing UBT profile configurations
get
Update existing UBT profile configurations
patch
Create a new UBT profile by unique name
post
Aaa Macauth
Read existing MAC authentication configuration
get
Delete an existing MAC authentication profile
del
Read an existing MAC authentication profile
get
Update an existing MAC authentication profile
patch
Configure a new MAC authentication profile
post
Auth Server Group
Read configuration of Authentication Server Group
get
Delete the Authentication Server Group profile
del
Read existing Authentication Server Group profile configuration
get
Update existing Authentication Server Group profile configuration
patch
Create a new Authentication Server Group profile by unique name
post
Device Certificate
Read Device Certificate configuration.
get
Delete Device Certificate by certificate name.
del
Read Device Certificate by certificate name.
get
Update Device Certificate by certificate name.
patch
Create Device Certificate by certificate name.
post
Certificate
Read certificates
get
Delete certificate by name
del
Read certificate by name
get
Update certificate by name
patch
Create certificate by name
post
802dot11k
Read existing 802.11k related settings.
get
Delete 802.11k profile.
del
Read existing 802.11k profile.
get
Update profile by name
patch
Create 802.11k profile.
post
Port Security
Read Port-Security configuration.
get
Delete the Port-Security policy.
del
Read existing Port-Security policy configuration.
get
Update existing Port-Security policy configuration.
patch
Create a new Port-Security policy.
post
Aaa Stateful Dot1x
Read stateful-dot1x-profiles
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Keychain
Read keychain configuration
get
Delete existing keychain
del
Read existing keychain
get
Update existing keychain
patch
Configure a new keychain
post
Copp
Get CoPP configuration
get
Delete CoPP profile, which describes all CoPP policies configured on the switch
del
Get CoPP profile, which describes all CoPP policies configured on the switch
get
Update profile by name
patch
Create CoPP profile, which describes all CoPP policies configured on the switch
post
Mka
Read MKA configuration
get
Delete existing MKA policy
del
Read existing MKA policy
get
Update existing MKA policy
patch
Configure a new MKA policy
post
Macsec
Read MACsec configuration
get
Delete existing MACsec policy
del
Read existing MACsec policy
get
Update existing MACsec policy
patch
Configure a new MACsec policy
post
Mac Lockout
Read mac lockout profiles
get
Delete mac lockout profile
del
Read existing mac lockout profile configurations
get
Update existing mac lockout profile configurations
patch
Create a new mac lockout profile by unique name
post
Auth Survivability
Read configuration of authentication survivability
get
Delete the authentication survivability profile
del
Read existing authentication survivability profile configuration
get
Update existing authentication survivability profile configuration
patch
Create a new authentication survivability profile by unique name
post
Net Group
Read net-groups
get
Delete net-group by name
del
Read net-group by name
get
Update net-group by name
patch
Create net-group by name
post
802dot11k Bcn Rpt Req
Read existing Beacon Report Request related settings.
get
Delete Beacon Report Request profile.
del
Read existing Beacon Report Request profile.
get
Update profile by name
patch
Create Beacon Report Request profile.
post
Est
Read configuration of EST Profile.
get
Delete the EST profile
del
Read existing EST profile configuration
get
Update existing EST profile configuration
patch
Create a new EST profile by unique name
post
Services
Airgroup System
Delete airgroup-system
del
Read existing system configuration
get
Modify system configuration
patch
Create new system configuration
post
Airgroup Policy
Read airgroup-policies
get
Delete existing service policy
del
Read existing service policy
get
Modify service policy
patch
Create new service policy
post
Location
Read location configuration
get
Delete location profile
del
Read existing location configurations
get
Update a new location profile by unique name
patch
Create a new location profile by unique name
post
Airgroup Servers
Read airgroup-servers
get
Delete existing server
del
Read existing server
get
Modify server
patch
Create new server
post
Airgroup Service Definition
Read airgroup-service-definitions
get
Delete existing custom service definition
del
Read existing service definition
get
Modify service definition
patch
Create new custom service definition
post
System
Dump Server
Read configured dump server
get
Delete the profile for dump server
del
Read configured profile for dump server
get
Update existing dump server profile configurations
patch
Create profile for dump server
post
Rmon Alarm
Read existing rmon-alarm configurations
get
Delete the rmon-alarm
del
Read existing rmon-alarm configurations
get
Update existing rmon-alarm configurations
patch
Create a new rmon-alarm by unique name
post
Sysmon
Read existing sysmon configurations
get
Delete the sysmon
del
Read existing sysmon configurations
get
Update existing sysmon configurations
patch
Create a new sysmon by unique name
post
Switch Profiles
Read Switch profiles.
get
Delete selected Switch profile with associated name and description.
del
Read selected Switch profile with associated name and description.
get
Update profile by name
patch
Add selected Switch profile with associated name and description.
post
Management User
Read the management users
get
Delete the management users list
del
Read the management users list
get
Update the existing management users list
patch
Create the management users list
post
Telemetry
Read configured telemetry
get
Delete the profile for telemetry
del
Read configured profile for telemetry
get
Update existing telemetry profile configurations
patch
Create profile for telemetry
post
Ntp
Read ntp
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
System Info
Delete system-info
del
Read system-info
get
Update system-info
patch
Create system-info
post
Nae Agent
Read NAE agents
get
Delete NAE agent
del
Read NAE agent
get
Update NAE agent
patch
Create NAE agent
post
Logging
Read existing logging profile configurations
get
Delete the logging
del
Read existing logging configurations
get
Update existing logging configurations
patch
Create a new logging by unique name
post
Dns
Read existing DNS profiles
get
Delete existing DNS profile
del
Read existing DNS profile
get
Modify DNS profile
patch
Create a new DNS profile
post
Container
Read existing Container configuration profiles
get
Delete existing Container configuration profile
del
Read existing Container configuration profile
get
Modify existing Container configuration profile
patch
Create a new Container configuration profile
post
Snmp
Read configured SNMP profiles
get
Delete the SNMP profile
del
Read existing SNMP profile configurations
get
Update existing SNMP profile configurations
patch
Create a new SNMP profile by unique profile name
post
Local Management
Read Local Management Profiles.
get
Delete a Local Management Profile by name.
del
Read existing Local Management Profile by name.
get
Update existing Local Management Profile by name.
patch
Create a new Local Management Profile by name.
post
Http Proxy
Read http-proxy-servers
get
Delete the profile for HTTP proxy server
del
Read configured profile for HTTP proxy server
get
Update existing HTTP proxy server profile configurations
patch
Create profile for HTTP proxy server
post
Switch System
Read switch-system
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Ap System
Read configured ap system
get
Delete the profile for AP system
del
Read configured profile for AP system
get
Update existing AP system profile configurations
patch
Create profile for AP system
post
Container Network
Read existing Container Network configuration profiles
get
Delete existing Container Network configuration profile
del
Read existing Container Network configuration profile
get
Modify existing Container Network configuration profile
patch
Create a new Container Network configuration profile
post
Countermon
Read existing countermon configurations
get
Delete the countermon
del
Read existing countermon configurations
get
Update existing countermon configurations
patch
Create a new countermon by unique name
post
Db Observer
Read db-observer
get
Delete db-observer-rules by name
del
Read db-observer-rules by name
get
Update db-observer-rules by name
patch
Create db-observer-rules by name
post
Ip Source Interface
Read IPv4/IPv6 Source Interface configurations
get
Delete profile for IPv4/IPv6 Source Interface configurations
del
Read profile for IPv4/IPv6 Source Interface configurations
get
Update profile for IPv4/IPv6 Source Interface configurations
patch
Create profile for IPv4/IPv6 Source Interface configurations
post
Remote Management
Read existing Remote Management configuration profiles
get
Delete existing Remote Management configuration profile
del
Read existing Remote Management configuration profile
get
Modify existing Remote Management configuration profile
patch
Create a new Remote Management configuration profile
post
Gw System
Read the configured Gateway System Profiles
get
Delete a gateway system profile
del
Read an existing gateway system profile configuration
get
Update existing gateway system profile configurations
patch
Create gateway system profile configurations
post
Custom Get Api
Read custom-get-api
get
Speed Test
Read speed-test
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Ddns
Read existing IETF based DDNS profiles
get
Delete existing IETF based DDNS profile
del
Read existing IETF based DDNS profile
get
Modify IETF based DDNS profile
patch
Create a new DDNS profile supporting IETF protocol
post
Job Scheduler
Read existing job-scheduler configurations
get
Delete the schedule
del
Read existing schedule configurations
get
Update existing schedule configurations
patch
Create a new schedule by unique name
post
Nae Script
Read NAE scripts
get
Delete NAE script
del
Read NAE script
get
Update NAE script
patch
Create NAE script
post
Hardware Module Profile
Get hardware module profile
get
Delete hardware module profile by module name
del
Get hardware module profile by module name
get
Update hardware module profile by module name
patch
Create hardware module profile by module name
post
Config Assignment
Read config-assignments
get
Delete config-assignment by scope-id, device-function, profile-type, profile-instance
del
Read config-assignment by scope-id, device-function, profile-type, profile-instance
get
Create config-assignment by scope-id, device-function, profile-type, profile-instance
post
Ipm
Read configured Intelligent Power Monitoring(IPM)
get
Delete the profile for IPM
del
Read configured profile for IPM
get
Update existing IPM profile configurations
patch
Create profile for IPM
post
Feature Pack
Read management-server
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Packet Capture
Read packet-capture
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Snmp Trap
Read configured SNMP Trap profiles
get
Delete the SNMP traps profile
del
Read existing SNMP traps profile configurations
get
Update existing SNMP traps profile configurations
patch
Create a new SNMP traps profile by unique profile name
post
Timerange
Read configured time ranges
get
Delete the profile for time range
del
Read configured profile for time range
get
Update existing time range profile configurations
patch
Create profile for time range
post
Switch Chassis
Read switch-chassis
get
Delete chassis by chassis-name
del
Read chassis by chassis-name
get
Update chassis by chassis-name
patch
Create chassis by chassis-name
post
Telemetry
Devicefingerprinting Interface
Read existing device-fingerprinting configuration on the interface
get
Delete the device-fingerprinting interface profile.
del
Read configured device-fingerprinting interface profile name
get
Update existing device-fingerprinting interface profile configurations.
patch
Create device-fingerprinting interface profile name.
post
Client Iptracker Interface
Read existing client-iptracker configurations on the interface.
get
Delete the profile for client-iptracker on the interface.
del
Read configured profile for client-iptracker on the interface.
get
Update existing client-iptracker profile configurations on the interface.
patch
Create profile name for client-iptracker on the interface.
post
Flow Tracking
Read configured FLow Tracking profiles
get
Delete the Flow Tracking profile
del
Read existing Flow Tracking profile configurations
get
Update profile by name
patch
Create a new Flow Tracking profile by unique name
post
Devicefingerprinting
Read existing device-fingerprinting configuration.
get
Delete the device-fingerprinting profile configurations.
del
Read configured device-fingerprinting profile configurations.
get
Update existing device-fingerprinting profile configurations
patch
Create device-fingerprinting profile configurations.
post
Client Insight
Read existing client-insight configurations
get
Delete the profile for client-insight
del
Read configured profile for client-insight
get
Update existing client-insight profile configurations
patch
Create profile name for client-insight
post
Traffic Insight
Read configured Traffic-insight Instance
get
Delete the Traffic-Insight Instance
del
Read existing Traffic-insight Configurations
get
Update existing Traffic-insight instance configurations
patch
Create Instance name for Traffic-Insight
post
Devicefingerprinting Profile
Read existing device-fingerprinting switch profile configuration
get
Delete the device-fingerprinting switch profile.
del
Read configured device-fingerprinting switch profile.
get
Update existing device-fingerprinting switch profile configurations.
patch
Create device-fingerprinting switch profile.
post
Client Iptracker
Read existing client-iptracker configurations
get
Delete the profile configured for client-iptracker
del
Read configured profile for client-iptracker
get
Update existing client-iptracker profile configurations
patch
Create profile name for client-iptracker configurations
post
Tunnels
Interface Tunnel Group
Read configured GRE Tunnel-groups
get
Delete GRE tunnel-group
del
Read existing GRE tunnel-group configurations
get
Update existing GRE tunnel-group configurations
patch
Create a new GRE tunnel-group
post
Interface Tunnel
Read configured Tunnel Interface
get
Delete a Tunnel interface
del
Read existing Tunnel interface configurations
get
Update existing Tunnel interface configurations
patch
Create a new Tunnel interface by unique id
post
VLANs & Networks
Vrrp Interface
Read VRRP-interface configuration
get
Delete a VRRP-interface profile
del
Read an existing VRRP-interface profile
get
Update an existing VRRP-interface profile
patch
Create a VRRP-interface profile
post
Mvrp
Read existing MVRP Configuration.
get
Delete MVRP configurations for given name.
del
Read existing MVRP Configuration for given name.
get
Update existing MVRP configurations for given name.
patch
Configure MVRP by unique name.
post
Loop Protect
Read existing loop-protect Configuration.
get
Delete loop-protect configurations for given name.
del
Read existing loop-protect Configuration for given name.
get
Update existing loop-protect configurations for given name.
patch
Configure loop-protect by unique name.
post
Named Vlan
Read Named-VLAN/VLAN-Group profiles
get
Delete Named-VLAN/VLAN-Group profile
del
Read Named-VLAN/VLAN-Group profile
get
Update Named-VLAN/VLAN-Group profile
patch
Create Named-VLAN/VLAN-Group profile
post
Static Neighbor
Read static-neighbor
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Stp
Read existing STP Configuration.
get
Delete STP configurations for given name.
del
Read existing STP Configuration for given name.
get
Update existing STP configurations for given name.
patch
Configure STP by unique name.
post
Vlan
Read L2-VLAN IDs
get
Delete L2-VLAN
del
Read L2-VLAN
get
Update L2-VLAN
patch
Create L2-VLAN
post
Vrrp
Read VRRP configuration
get
Delete a VRRP profile
del
Read an existing VRRP profile
get
Update an existing VRRP profile
patch
Create a VRRP profile
post
Vlan Range
Add or Update range of VLAN profiles
post
Smartlink
Read existing Smartlink configuration.
get
Delete smartlink configuration for given name.
del
Read existing smartlink configuration for given name.
get
Update existing smartlink configuration for given name.
patch
Configure smartlink by unique name.
post
Wireless
Passpoint
Read existing Passpoint related settings.
get
Delete Passpoint profile.
del
Read existing Passpoint profile.
get
Update profile by name
patch
Create new Passpoint profile.
post
Radio
Read configured radios.
get
Delete the radio profile.
del
Read existing radio profile configurations.
get
Update profile by name
patch
Create a new radio profile by unique name.
post
Ids
Read configured policies about IDS
get
Delete the IDS policy
del
Read existing IDS configurations
get
Update profile by name
patch
Create a new policy
post
Wlan
Read configuration of WLAN SSID profile
get
Delete the WLAN SSID profile
del
Read existing WLAN SSID profile configuration
get
Update existing WLAN SSID profile configuration
patch
Create a new WLAN SSID profile by unique name
post
Alg
Read alg
get
Delete profile by name
del
Read profile by name
get
Update profile by name
patch
Create profile by name
post
Mpsk Local
Read configuration of MPSK Local
get
Delete the MPSK LOCAL profile
del
Read existing MPSK LOCAL profile configuration
get
Update existing MPSK LOCAL profile configuration
patch
Create a new MPSK LOCAL profile by unique name
post
Mesh
Read configuration of Mesh network topology
get
Delete the Mesh network profile
del
Read existing Mesh network profile
get
Update profile by name
patch
Create a new Mesh network profile
post
Powered by
Read rip
get
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/rip
RIP Configurations.
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
Client
URL
Base URL
https://de1.api.central.arubanetworks.com
/network-config/v1alpha1/rip
Response
Click
Try It!
to start a request and see the response here!