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
Search
JUMP TO
Scope Management
Sites
Get sites
get
Create site
post
Update site
put
Delete site by scopeId
del
Bulk delete sites
del
Site Collections
Get site-collections
get
Create site-collection
post
Update site-collection
put
Delete site-collection by scopeId
del
Bulk delete site-collections
del
Add sites to existing site-collection
post
Remove sites from site-collection
del
Device Groups
Get device-groups
get
Hierarchy
Get scope hierarchy
get
Application Experience
Airgroup System
Create new system configuration
post
Read existing system configuration
get
Modify system configuration
patch
Delete airgroup-system
del
App Recog Control
Read existing ARC Configuration
get
Create new ARC profile of {name}
post
Read existing ARC profile of {name}
get
Update existing ARC profile of {name}
patch
Delete ARC profile of {name}
del
Ucc
Read ucc
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Airgroup Policy
Read airgroup-policies
get
Create new service policy
post
Read existing service policy
get
Modify service policy
patch
Delete existing sdervice policy
del
Airgroup Service Definition
Read airgroup-service-definitions
get
Create new custom service definition
post
Read existing service definition
get
Modify service definition
patch
Delete existing custom service definition
del
Central NAC
Cda Authz Policy
Read authorization policy configuration(s).
get
Create authorization policy configuration.
post
Read authorization policy configuration.
get
Update authorization policy configuration.
patch
Delete authorization policy configuration.
del
Cda Airpass Approval
Read Air Pass profile configuration(s).
get
Read authentication approval configuration.
get
Cda Identity Store
Read identity stores configuration(s).
get
Create identity store configuration.
post
Read identity store configuration.
get
Update identity store configuration.
patch
Delete identity store configuration.
del
Cda Portal Profile
Read portal profiles
get
Create a portal profile
post
Read a portal profile
get
Update a portal profile
patch
Delete a portal profile
del
Cda Auth Profile
Read authentication profile configuration(s).
get
Create authentication profile configuration.
post
Read authentication profile configuration.
get
Update authentication profile configuration.
patch
Delete authentication profile configuration.
del
Cda Portal Skin Profile
Read portal skin profiles
get
Create a portal skin profile
post
Read a portal skin profile
get
Update a portal skin profile
patch
Delete a portal skin profile
del
Cda Message Provider
Read message provider profiles
get
Create a message provider profile
post
Read a message provider profile
get
Update a message provider profile
patch
Delete a message provider profile
del
Cda Portal Overrides Profile
Read portal overrides profiles
get
Create a portal overrides profile
post
Read a portal overrides profile
get
Update a portal overrides profile
patch
Delete a portal overrides profile
del
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
Config Management
Config Checkpoint
Read configuration checkpoint profiles
get
Create new Checkpoint configuration profile
post
Read existing Checkpoint configuration profile
get
Update existing Checkpoint configuration profile
patch
Delete existing Checkpoint configuration profile
del
Configuration Health
Configuration Health
Returns active configuration issues for a device.
get
Returns summary of configuration health for devices.
get
Extensions
Extension Vsphere
Read vsphere-instances
get
Create vsphere-instance by {name}
post
Read vsphere-instance by {name}
get
Update vsphere-instance by {name}
patch
Delete vsphere-instance by {name}
del
High Availability
Switch Stack
Read configured stacks
get
Create a new stack by unique name
post
Read existing stack configurations
get
Update existing stack configurations
patch
Delete the stack
del
Vsx
Read vsx profiles
get
Create vsx by {name}
post
Read vsx by {name}
get
Update vsx by {name}
patch
Delete vsx by {name}
del
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
Interfaces
Interface Loopback
Read loopback interface(s) configurations
get
Create loopback interface configurations
post
Read loopback interface configurations
get
Update loopback interface configurations
patch
Delete loopback interface configurations
del
Interface Management
Read Management interface configurations
get
Create profile for Management interface configurations
post
Read profile for Management interface configurations
get
Update profile for Management interface configurations
patch
Delete profile for Management interface configurations
del
Ufd
Read existing UFD Configuration.
get
Configure UFD by unique name.
post
Read existing UFD Configuration for given name.
get
Update existing UFD configurations for given name.
patch
Delete UFD configurations for given name.
del
Fault Monitor
Read configured fault monitor profiles
get
Create a new fault monitor profile by unique name
post
Read existing fault monitor profile configurations
get
Update the existing fault monitor profile configurations
patch
Delete the fault monitor profile
del
Ap Uplink
Read existing uplink parameters
get
Create an uplink profile
post
Read the existing uplink profile
get
Update profile by {name}
patch
Delete the uplink profile
del
Sflow
Read configured sFlow Configuration
get
Configure sFlow by unique name.
post
Read existing sFlow Configuration.
get
Update existing sFlow configurations.
patch
Delete sFlow configurations.
del
Interface Subinterface
Read sub-interface(s) configurations
get
Create sub-interface configurations
post
Read sub-interface configurations
get
Update sub-interface configurations
patch
Delete sub-interface configurations
del
Lldp
Read existing LLDP configuration.
get
Configure LLDP by unique name.
post
Read existing LLDP configuration for given name.
get
Update existing LLDP configuration for given name.
patch
Delete LLDP configuration for given name.
del
Sw Port Profile
Read configured switch port profiles
get
Create a new switch port profile by unique name
post
Read existing switch port profile configurations
get
Update existing switch port profile configurations
patch
Delete the switch port profile
del
Interface Vlan
Read VLAN interface(s) configurations
get
Create VLAN interface configurations
post
Read VLAN interface configurations
get
Update VLAN interface configurations
patch
Delete VLAN interface configurations
del
Interface Portchannel
Read port channel(s) interface configurations
get
Create port channel interface configurations
post
Read port channel interface configurations
get
Update port channel interface configurations
patch
Delete port channel interface configurations
del
Cdp
Read existing CDP configuration.
get
Configure CDP by unique name.
post
Read existing CDP configuration for given name.
get
Update existing CDP configuration for given name.
patch
Delete CDP configuration for given name.
del
Dhcp Client
Read DHCP Client configurations
get
Create profile for DHCP Client configurations
post
Read profile for DHCP Client configurations
get
Update profile for DHCP Client configurations
patch
Delete profile for DHCP Client configurations
del
Interface Ethernet
Read interface(s) configurations
get
Create interface configurations
post
Read interface configurations
get
Update interface configurations
patch
Ap Port Profile
Read configured port profiles
get
Create a new port profile by unique name
post
Read existing port profile configuration
get
Update profile by {profileName}
patch
Delete the port profile
del
Lacp
Create LACP configuration at the system level
post
Read existing configuration at the system level
get
Modify LACP configuration at the system level
patch
Delete existing LACP configuration at the system level
del
Interface Profile
Read existing Interface Profile Configuration.
get
Configure Interface Profile by unique name.
post
Read existing Interface Profile Configuration for given name.
get
Update existing Interface Profile configurations for given name.
patch
Delete Interface Profile configurations for given name.
del
IoT
Iot
Read configured IoT parameters
get
Create a new IoT profile by unique name
post
Read existing IoT profile configurations
get
Update profile by {name}
patch
Delete the IoT profile
del
Usb
Read configured usb parameters
get
Create a new usb configuration by unique name
post
Read existing usb configuration configurations
get
Update profile by {name}
patch
Delete the usb configuration
del
Miscellaneous
Switch Profiles
Read Switch profiles.
get
Add selected Switch profile with associated name and description.
post
Read selected Switch profile with associated name and description.
get
Update profile by {name}
patch
Delete selected Switch profile with associated name and description.
del
Mirror Endpoint
Read configured mirror-endpoints.
get
Create/update mirror-endpoints and associated them with profile. This wraps one or more mirror-endpoints within the context of a profile.
post
Read configured mirror-endpoints associated with profile.
get
Update profile by {name}
patch
Delete all mirror-endpoints associated with profile.
del
Object Group
Read Object Groups
get
Add Object Group
post
Read Object Group
get
Update Object Group
patch
Delete Object Group
del
Switch Chassis
Read switch-chassis
get
Create chassis by {chassisName}
post
Read chassis by {chassisName}
get
Update chassis by {chassisName}
patch
Delete chassis by {chassisName}
del
Device Certificate
Read Device Certificate configuration.
get
Create Device Certificate by certificate name.
post
Read Device Certificate by certificate name.
get
Update Device Certificate by certificate name.
patch
Delete Device Certificate by certificate name.
del
Extension Splunk
Read splunk-instances
get
Create instance by {name}
post
Read instance by {name}
get
Update instance by {name}
patch
Delete instance by {name}
del
Packet Capture
Read packet-capture
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Static Neighbor
Read static-neighbor
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Profile Operation
Create profile-rename
post
Read profile-rename
get
Update profile-rename
patch
Delete profile-rename
del
Device Info
Read device-parameters
get
Create platforms by {platformModel}
post
Read platforms by {platformModel}
get
Update platforms by {platformModel}
patch
Delete platforms by {platformModel}
del
Db Observer
Read db-observer
get
Create db-observer-rules by {name}
post
Read db-observer-rules by {name}
get
Update db-observer-rules by {name}
patch
Delete db-observer-rules by {name}
del
Track Object
Read tracking-object
get
Create vrrp by {identifier}
post
Read vrrp by {identifier}
get
Update vrrp by {identifier}
patch
Delete vrrp by {identifier}
del
Mirror
Read configured mirror sessions.
get
Create mirror session using profile.
post
Read configured mirror session associated with profile.
get
Update profile by {name}
patch
Delete mirror session associated with profile.
del
Hardware Module Profile
Get hardware module profile
get
Create hardware module profile by module name
post
Get hardware module profile by module name
get
Update hardware module profile by module name
patch
Delete hardware module profile by module name
del
Remote Management
Read existing Remote Management configuration profiles
get
Create a new Remote Management configuration profile
post
Read existing Remote Management configuration profile
get
Modify existing Remote Management configuration profile
patch
Delete existing Remote Management configuration profile
del
Persona Mapping
Read device-persona-mapping
get
Create device-type-list by {deviceType}
post
Read device-type-list by {deviceType}
get
Update device-type-list by {deviceType}
patch
Delete device-type-list by {deviceType}
del
Ip Routing
Read ip-routing
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Feature Pack
Read management-server
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Persona Assignment
Create persona-device-list by {deviceFunction}
post
Static Mac
Read Static MAC profiles.
get
Add Static MAC addresses with associated VLAN and port.
post
Read associated Static MACs & their configuration.
get
Update profile by {name}
patch
Delete associated Static MACs & their configuration.
del
Named Object
Net Service
Read Net Services configuration
get
Add Net Service configuration
post
Read Net Service configuration
get
Update existing Net Service configuration
patch
Delete Net Service configuration
del
Alias
Read aliases
get
Create alias by {name}
post
Read alias by {name}
get
Update alias by {name}
patch
Delete alias by {name}
del
Network Services
Dhcp Pool
Read dhcp-pool
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Dynamic Arp Inspection
Read existing Dynamic ARP Inspection global configuration
get
Create new profile for Dynamic ARP Inspection
post
Read configured profile for Dynamic ARP Inspection
get
Update existing Dynamic ARP Inspection profile configuration
patch
Delete the profile for Dynamic ARP Inspection
del
Multicast Dns
Read existing Multicast DNS configurations
get
Create profile name for Multicast DNS
post
Read configured profile for Multicast DNS
get
Update existing Multicast DNS profile configurations
patch
Delete the profile for Multicast DNS
del
Nae Lite
Read existing nae-lite agent configurations
get
Create a new nae-lite agent by unique name
post
Read existing nae-lite agent configurations
get
Update existing nae-lite agent configurations
patch
Delete the nae-lite agent
del
External Storage
Read External Storage configurations
get
Create profile for External Storage configurations
post
Read profile for External Storage configurations
get
Update profile for External Storage configurations
patch
Delete profile for External Storage configurations
del
Dhcp Snooping
Read existing DHCP-Snooping configuration
get
Create new profile for DHCP-Snooping
post
Read configured profile for DHCP-Snooping
get
Update existing DHCP-Snooping profile configuration
patch
Delete the profile for DHCP-Snooping
del
Nae Script
Read nae-scripts
get
Create nae-script by {name}
post
Read nae-script by {name}
get
Update nae-script by {name}
patch
Delete nae-script by {name}
del
Ip Binding
Read existing source ip binding configuration
get
Create new static entry configuration
post
Read existing static entry configuration
get
Update existing static entry configuration
patch
Delete static entry configuration
del
Ip Lockdown
Read existing IP source lockdown configuration
get
Create new IP source lockdown profile
post
Read existing IP source lockdown profile
get
Update existing IP source lockdown profile
patch
Delete IP source lockdown profile
del
Dhcp Relay
Read DHCPv4/DHCPv6 Relay configurations
get
Create profile for DHCPv4/DHCPv6 Relay configurations
post
Read profile for DHCPv4/DHCPv6 Relay configurations
get
Update profile for DHCPv4/DHCPv6 Relay configurations
patch
Delete profile for DHCPv4/DHCPv6 Relay configurations
del
Mgmd
Read existing Multicast Group Membership Discovery Protocol configurations
get
Create profile for MGMD
post
Read configured profile for MGMD
get
Update existing MGMD profile configurations
patch
Delete the profile for MGMD
del
Ipsla
Read ipsla
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Nae Agent
Read nae-agents
get
Create nae-agent by {agentName}
post
Read nae-agent by {agentName}
get
Update nae-agent by {agentName}
patch
Delete nae-agent by {agentName}
del
Nd Snooping Interface
Read existing ND-Snooping interface configuration
get
Create new profile for ND-Snooping interface configuration
post
Read configured profile for ND-Snooping interface configuration
get
Update existing ND-Snooping interface configuration profile configuration
patch
Delete the profile for ND-Snooping interface configuration
del
Nd Snooping
Read existing ND-Snooping configuration
get
Create new profile for ND-Snooping
post
Read configured profile for ND-Snooping
get
Update existing ND-Snooping profile configuration
patch
Delete the profile for ND-Snooping
del
Dhcp Server
Read DHCPv4/DHCPv6 Server configurations
get
Create profile for DHCPv4/DHCPv6 Server configurations
post
Read profile for DHCPv4/DHCPv6 Server configurations
get
Update profile for DHCPv4/DHCPv6 Server configurations
patch
Delete profile for DHCPv4/DHCPv6 Server configurations
del
Dynamic Arp Inspection Interface
Read existing Dynamic ARP Inspection interface configuration
get
Create new profile for Dynamic ARP Inspection interface configuration
post
Read configured profile for Dynamic ARP Inspection interface configuration
get
Update existing Dynamic ARP Inspection interface configuration profile configuration
patch
Delete the profile for Dynamic ARP Inspection interface configuration
del
Dhcp Snooping Interface
Read existing DHCP-Snooping interface configuration
get
Create new profile for DHCP-Snooping interface configuration
post
Read configured profile for DHCP-Snooping interface configuration
get
Update existing DHCP-Snooping interface configuration profile configuration
patch
Delete the profile for DHCP-Snooping interface configuration
del
Ip Lockdown Interface
Read existing IP source lockdown interface configuration
get
Create new IP source lockdown interface profile
post
Read existing IP source lockdown interface profile
get
Update existing IP source lockdown interface profile
patch
Delete IP source lockdown interface profile
del
Udp Broadcast Forwarder
Read UDP Broadcast Forwarder configurations
get
Create profile for UDP Broadcast Forwarder configurations
post
Read profile for UDP Broadcast Forwarder configurations
get
Update profile for UDP Broadcast Forwarder configurations
patch
Delete profile for UDP Broadcast Forwarder configurations
del
Roles & Policy
Role Acl
Read Role ACLs
get
Add Role ACL
post
Read Role ACL
get
Update Role ACL
patch
Delete Role ACL
del
Policy Group
Create policy-groups
post
Read policy-groups
get
Update policy-groups
patch
Delete policy-groups
del
Policy
Read existing policies
get
Create a policy by unique name
post
Read the existing policy configuration
get
Update policy by {name}
patch
Delete the policy
del
Role
Read existing roles
get
Create a role by unique name
post
Read the existing role configuration
get
Update role
patch
Delete the role
del
Role Gpid
Read existing roles
get
Create a role with gpid
post
Read the existing role configuration
get
Update role
patch
Delete the role
del
Routing & Overlays
Community List
Read existing community-list configuration
get
Create community-list by {communityListNameCommunityType}
post
Read community-list by {communityListNameCommunityType}
get
Update community-list by {communityListNameCommunityType}
patch
Delete community-list by {communityListNameCommunityType}
del
Rip
Read rip
get
Create a RIP profile
post
Read an existing RIP profile
get
Update an existing RIP profile
patch
Delete a RIP profile
del
Msdp
Read existing Multicast Source Discovery Protocol configurations
get
Create profile name for MSDP
post
Read configured profile for MSDP
get
Update existing MSDP profile configurations
patch
Delete the profile for MSDP
del
Prefix List
Read existing prefix-list configuration
get
Create new prefix-list with name {prefixListName} under address-family {AddressFamily}
post
Read existing prefix-list with name {prefixListName} under address-family {AddressFamily}
get
Update existing prefix-list with name {prefixListName} under address-family {AddressFamily}
patch
Delete prefix-list with name {prefixListName} under address-family {AddressFamily}
del
Multicast
Read existing Multicast Protocol configurations
get
Create profile name for Multicast
post
Read configured profile for Multicast
get
Update existing Multicast profile configurations
patch
Delete the profile for Multicast
del
Static Route
Read static-route
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Ospfv2
Read ospfv2
get
Create routers by {instanceTagVrf}
post
Read routers by {instanceTagVrf}
get
Update routers by {instanceTagVrf}
patch
Delete routers by {instanceTagVrf}
del
Ospfv3
Read ospfv3
get
Create routers by {instanceTagVrf}
post
Read routers by {instanceTagVrf}
get
Update routers by {instanceTagVrf}
patch
Delete routers by {instanceTagVrf}
del
Evpn
Read existing EVPN configuration
get
Create new EVPN profile {name}
post
Read existing EVPN profile {name}
get
Update existing configuration EVPN profile {name}
patch
Delete EVPN profile {name}
del
Multicast Static Route
Read existing Multicast Static Route configurations
get
Create profile for Multicast Static Route
post
Read configured profile for Multicast Static Route
get
Update existing Multicast Static Route profile configurations
patch
Delete the profile for Multicast Static Route
del
Bgp
Read existing BGP router configuration
get
Create BGP profile.
post
Read existing BGP profile.
get
Update profile by {name}
patch
Delete BGP profile.
del
Pim
Read existing Protocol Independent Multicast configurations
get
Create profile name for PIM
post
Read configured profile for PIM
get
Update existing PIM profile configurations
patch
Delete the profile for PIM
del
Aspath List
Read existing aspath-list configuration
get
Create new as-path-list with name {aspathListName}
post
Read existing as-path-list with name {aspathListName}
get
Update existing as-path-list with name {aspathListName}
patch
Delete as-path-list with name {aspathListName}
del
Routemap
Read existing route-map configuration
get
Create new route-map with name {name}
post
Read existing route-map with name {name}
get
Update existing route-map with name {name}
patch
Delete route-map with name {name}
del
L3 Route
Read l3-route
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Vrf
Read existing VRFs
get
Create new VRF {name}
post
Read configuration for existing VRF {name}
get
Update configuration for existing VRF {name}
patch
Delete VRF {name}
del
Bfd
Read bfd
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Security
Certificate Rcp
Read certificate-rcp
get
Create ta-profile by {name}
post
Read ta-profile by {name}
get
Update ta-profile by {name}
patch
Delete ta-profile by {name}
del
Auth Survivability
Read configuration of authentication survivability
get
Create a new authentication survivability profile by unique name
post
Read existing authentication survivability profile configuration
get
Update existing authentication survivability profile configuration
patch
Delete the authentication survivability profile
del
Keychain
Read keychain configuration
get
Configure a new keychain
post
Read existing keychain
get
Update existing keychain
patch
Delete existing keychain
del
Net Group
Read net-groups
get
Create net-group by {name}
post
Read net-group by {name}
get
Update net-group by {name}
patch
Delete net-group by {name}
del
Auth Server Group
Read configuration of Authentication Server Group
get
Create a new Authentication Server Group profile by unique name
post
Read existing Authentication Server Group profile configuration
get
Update existing Authentication Server Group profile configuration
patch
Delete the Authentication Server Group profile
del
Radius Modifiers
Read configuration of Radius modifier
get
Create a new Radius modifier profile by unique name
post
Read existing Radius modifier profile configuration
get
Update existing Radius modifier profile configuration
patch
Delete the Radius modifier profile
del
Est
Read configuration of EST Profile.
get
Create a new EST profile by unique name
post
Read existing EST profile configuration
get
Update existing EST profile configuration
patch
Delete the EST profile
del
Aaa Macauth
Read existing MAC authentication configuration
get
Configure a new MAC authentication profile
post
Read an existing MAC authentication profile
get
Update an existing MAC authentication profile
patch
Delete an existing MAC authentication profile
del
Auth Server Global
Read configuration of Auth Server Global
get
Create profile name for Auth Server Global
post
Read configured profile for Auth Server Global
get
Update existing Auth Server Global profile configurations
patch
Delete the profile for Auth Server Global
del
Mka
Read MKA configuration
get
Configure a new MKA policy
post
Read existing MKA policy
get
Update existing MKA policy
patch
Delete existing MKA policy
del
Certificate Store
Read certificate-store
get
Create certificate by {name}
post
Read certificate by {name}
get
Update certificate by {name}
patch
Delete certificate by {name}
del
Aaa Stateful Dot1x
Read stateful-dot1x-profiles
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Aaa Profile
Read an existing AAA profile
get
Configure a new AAA profile
post
Read an exiting AAA profile
get
Update an exiting AAA profile
patch
Delete an exiting AAA profile
del
Aaa Captive Portal
Read configuration of external captive portal
get
Create a new external captive profile by unique name
post
Read existing external captive profile configuration
get
Update existing external captive profile configuration
patch
Delete the external captive profile
del
802dot11k
Read existing 802.11k related settings.
get
Create 802.11k profile.
post
Read existing 802.11k profile.
get
Update profile by {name}
patch
Delete 802.11k profile.
del
Certificate
Read certificates
get
Create certificate by {name}
post
Read certificate by {name}
get
Update certificate by {name}
patch
Delete certificate by {name}
del
802dot11k Bcn Rpt Req
Read existing Beacon Report Request related settings.
get
Create Beacon Report Request profile.
post
Read existing Beacon Report Request profile.
get
Update profile by {name}
patch
Delete Beacon Report Request profile.
del
Aaa Dot1xsupp
Read dot1xsupp
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Copp
Get CoPP configuration
get
Create CoPP profile, which describes all CoPP policies configured on the switch
post
Get CoPP profile, which describes all CoPP policies configured on the switch
get
Update profile by {name}
patch
Delete CoPP profile, which describes all CoPP policies configured on the switch
del
Passpoint Identity
Read existing ANQP NAI Realm related settings.
get
Create ANQP NAI Realm profile.
post
Read existing ANQP NAI Realm profile.
get
Update profile by {name}
patch
Delete ANQP NAI Realm profile.
del
Ubt
Read configured UBT profiles
get
Create a new UBT profile by unique name
post
Read existing UBT profile configurations
get
Update existing UBT profile configurations
patch
Delete the UBT profile
del
Ap Certificate Usage
Read configuration of AP certificate usage
get
Create an AP certificate usage profile by unique name
post
Read existing AP certificate usage profile configurations
get
Update existing AP certificate usage profile configurations
patch
Delete the AP certificate usage profile
del
Firewall
Read configured firewall Profile
get
Create firewall Profile
post
Read existing firewall configuration
get
Update existing firewall configurations
patch
Delete the firewall profile
del
Auth Server
Read configuration of auth server profile
get
Create a new auth server profile by unique name
post
Read existing auth server profile configuration
get
Update existing auth server profile configuration
patch
Delete the auth server profile
del
Aaa Dot1xauth
Read existing 802.1X authentication configuration
get
Configure a new 802.1X authentication profile.
post
Read an existing 802.1X authentication profile
get
Update an existing 802.1X authentication profile
patch
Delete an existing 802.1X authentication profile
del
Port Security
Read Port-Security configuration.
get
Create a new Port-Security policy.
post
Read existing Port-Security policy configuration.
get
Update existing Port-Security policy configuration.
patch
Delete the Port-Security policy.
del
802dot11k Rrm Ie
Read existing RRM-IE related setting.
get
Create RRM-IE profile.
post
Read existing RRM-IE profile.
get
Update profile by {name}
patch
Delete RRM-IE profile.
del
Services
Location
Read location configuration
get
Create a new location profile by unique name
post
Read existing location configurations
get
Update a new location profile by unique name
patch
Delete location profile
del
System
Ip Source Interface
Read IPv4/IPv6 Source Interface configurations
get
Create profile for IPv4/IPv6 Source Interface configurations
post
Read profile for IPv4/IPv6 Source Interface configurations
get
Update profile for IPv4/IPv6 Source Interface configurations
patch
Delete profile for IPv4/IPv6 Source Interface configurations
del
Local Management
Read Local Management Profiles.
get
Create a new Local Management Profile by name.
post
Read existing Local Management Profile by name.
get
Update existing Local Management Profile by name.
patch
Delete a Local Management Profile by name.
del
Rmon Alarm
Read existing rmon-alarm configurations
get
Create a new rmon-alarm by unique name
post
Read existing rmon-alarm configurations
get
Update existing rmon-alarm configurations
patch
Delete the rmon-alarm
del
Management User
Read the management users
get
Create the management users list
post
Read the management users list
get
Update the existing management users list
patch
Delete the management users list
del
Ipm
Read configured Intelligent Power Monitoring(IPM)
get
Create profile for IPM
post
Read configured profile for IPM
get
Update existing IPM profile configurations
patch
Delete the profile for IPM
del
System Info
Create system-info
post
Read system-info
get
Update system-info
patch
Delete system-info
del
Dns
Read existing DNS profiles
get
Create a new DNS profile
post
Read existing DNS profile
get
Modify DNS profile
patch
Delete existing DNS profile
del
Container
Read existing Container configuration profiles
get
Create a new Container configuration profile
post
Read existing Container configuration profile
get
Modify existing Container configuration profile
patch
Delete existing Container configuration profile
del
Timerange
Read configured time ranges
get
Create profile for time range
post
Read configured profile for time range
get
Update existing time range profile configurations
patch
Delete the profile for time range
del
Logging
Read existing logging profile configurations
get
Create a new logging by unique name
post
Read existing logging configurations
get
Update existing logging configurations
patch
Delete the logging
del
Scopemap
Read scope-maps
get
Create scope-map by {scopeName}, {persona}, {resource}
post
Read scope-map by {scopeName}, {persona}, {resource}
get
Update scope-map by {scopeName}, {persona}, {resource}
patch
Delete scope-map by {scopeName}, {persona}, {resource}
del
Switch System
Read switch-system
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Countermon
Read existing countermon configurations
get
Create a new countermon by unique name
post
Read existing countermon configurations
get
Update existing countermon configurations
patch
Delete the countermon
del
Ip Icmp Tcp
Read ICMP and TCP configurations
get
Create profile for ICMP and TCP configurations
post
Read profile for ICMP and TCP configurations
get
Update profile for ICMP and TCP configurations
patch
Delete profile for ICMP and TCP configurations
del
Ntp
Read ntp
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Ap System
Read configured ap system
get
Create profile for AP system
post
Read configured profile for AP system
get
Update existing AP system profile configurations
patch
Delete the profile for AP system
del
Telemetry
Read configured telemetry
get
Create profile for telemetry
post
Read configured profile for telemetry
get
Update existing telemetry profile configurations
patch
Delete the profile for telemetry
del
Speed Test
Read speed-test
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Ddns
Read existing IETF based DDNS profiles
get
Create a new DDNS profile supporting IETF protocol
post
Read existing IETF based DDNS profile
get
Modify IETF based DDNS profile
patch
Delete existing IETF based DDNS profile
del
Custom Get Api
Read custom-get-api
get
Container Network
Read existing Container Network configuration profiles
get
Create a new Container Network configuration profile
post
Read existing Container Network configuration profile
get
Modify existing Container Network configuration profile
patch
Delete existing Container Network configuration profile
del
Sysmon
Read existing sysmon configurations
get
Create a new sysmon by unique name
post
Read existing sysmon configurations
get
Update existing sysmon configurations
patch
Delete the sysmon
del
Ddns Http
Read existing DDNS profiles supporting http(s) updates
get
Create new DDNS profile supporting http(s) updates
post
Read existing DDNS profile supporting http(s) updates
get
Modify DDNS profile supporting http(s) updates
patch
Delete existing DDNS profile supporting http(s) updates
del
Job Scheduler
Read existing job-scheduler configurations
get
Create a new schedule by unique name
post
Read existing schedule configurations
get
Update existing schedule configurations
patch
Delete the schedule
del
Http Proxy
Read http-proxy-servers
get
Create profile for HTTP proxy server
post
Read configured profile for HTTP proxy server
get
Update existing HTTP proxy server profile configurations
patch
Delete the profile for HTTP proxy server
del
Snmp
Read configured SNMP profiles
get
Create a new SNMP profile by unique profile name
post
Read existing SNMP profile configurations
get
Update existing SNMP profile configurations
patch
Delete the SNMP profile
del
Telemetry
Devicefingerprinting
Read existing device-fingerprinting configuration.
get
Create device-fingerprinting profile configurations.
post
Read configured device-fingerprinting profile configurations.
get
Update existing device-fingerprinting profile configurations
patch
Delete the device-fingerprinting profile configurations.
del
Flow Tracking
Read configured FLow Tracking profiles
get
Create a new Flow Tracking profile by unique name
post
Read existing Flow Tracking profile configurations
get
Update profile by {name}
patch
Delete the Flow Tracking profile
del
Client Insight
Read existing client-insight configurations
get
Create profile name for client-insight
post
Read configured profile for client-insight
get
Update existing client-insight profile configurations
patch
Delete the profile for client-insight
del
Devicefingerprinting Profile
Read existing device-fingerprinting switch profile configuration
get
Create device-fingerprinting switch profile.
post
Read configured device-fingerprinting switch profile.
get
Update existing device-fingerprinting switch profile configurations.
patch
Delete the device-fingerprinting switch profile.
del
Traffic Insight
Read configured Traffic-insight Instance
get
Create Instance name for Traffic-Insight
post
Read existing Traffic-insight Configurations
get
Update existing Traffic-insight instance configurations
patch
Delete the Traffic-Insight Instance
del
Devicefingerprinting Interface
Read existing device-fingerprinting configuration on the interface
get
Create device-fingerprinting interface profile name.
post
Read configured device-fingerprinting interface profile name
get
Update existing device-fingerprinting interface profile configurations.
patch
Delete the device-fingerprinting interface profile.
del
Client Iptracker Interface
Read existing client-iptracker configurations on the interface.
get
Create profile name for client-iptracker on the interface.
post
Read configured profile for client-iptracker on the interface.
get
Update existing client-iptracker profile configurations on the interface.
patch
Delete the profile for client-iptracker on the interface.
del
Client Iptracker
Read existing client-iptracker configurations
get
Create profile name for client-iptracker configurations
post
Read configured profile for client-iptracker
get
Update existing client-iptracker profile configurations
patch
Delete the profile configured for client-iptracker
del
Tunnels
Interface Tunnel
Read configured Tunnel Interface
get
Create a new Tunnel interface by unique id
post
Read existing Tunnel interface configurations
get
Update existing Tunnel interface configurations
patch
Delete a Tunnel interface
del
Interface Tunnel Group
Read configured GRE Tunnel-groups
get
Create a new GRE tunnel-group
post
Read existing GRE tunnel-group configurations
get
Update existing GRE tunnel-group configurations
patch
Delete GRE tunnel-group
del
VLANs & Networks
Vrrp
Read VRRP configuration
get
Create a VRRP profile
post
Read an existing VRRP profile
get
Update an existing VRRP profile
patch
Delete a VRRP profile
del
Mvrp
Read existing MVRP Configuration.
get
Configure MVRP by unique name.
post
Read existing MVRP Configuration for given name.
get
Update existing MVRP configurations for given name.
patch
Delete MVRP configurations for given name.
del
Smartlink
Read existing Smartlink configuration.
get
Configure smartlink by unique name.
post
Read existing smartlink configuration for given name.
get
Update existing smartlink configuration for given name.
patch
Delete smartlink configuration for given name.
del
Stp
Read existing STP Configuration.
get
Configure STP by unique name.
post
Read existing STP Configuration for given name.
get
Update existing STP configurations for given name.
patch
Delete STP configurations for given name.
del
Vlan Range
Add or Update range of VLAN profiles
post
Read layer2-vlan-range
get
Update layer2-vlan-range
patch
Delete layer2-vlan-range
del
Vrrp Interface
Read VRRP-interface configuration
get
Create a VRRP-interface profile
post
Read an existing VRRP-interface profile
get
Update an existing VRRP-interface profile
patch
Delete a VRRP-interface profile
del
Vlan
Read L2-VLAN IDs
get
Create L2-VLAN
post
Read L2-VLAN
get
Update L2-VLAN
patch
Delete L2-VLAN
del
Loop Protect
Read existing loop-protect Configuration.
get
Configure loop-protect by unique name.
post
Read existing loop-protect Configuration for given name.
get
Update existing loop-protect configurations for given name.
patch
Delete loop-protect configurations for given name.
del
Named Vlan
Read Named-VLAN/VLAN-Group profiles
get
Create Named-VLAN/VLAN-Group profile
post
Read Named-VLAN/VLAN-Group profile
get
Update Named-VLAN/VLAN-Group profile
patch
Delete Named-VLAN/VLAN-Group profile
del
Wireless
Hotspot2 Anqp Nai Realm
Read existing ANQP NAI Realm related settings.
get
Create ANQP NAI Realm profile.
post
Read existing ANQP NAI Realm profile.
get
Update anqp-nai-realm-profile by {name}
patch
Delete ANQP NAI Realm profile.
del
Hotspot2 Anqp Domain Name
Read existing ANQP domain name related settings.
get
Create ANQP domain name profile.
post
Read existing ANQP domain name profile.
get
Update anqp-domain-name-profile by {name}
patch
Delete ANQP domain name profile.
del
Passpoint
Read existing Passpoint related settings.
get
Create new Passpoint profile.
post
Read existing Passpoint profile.
get
Update profile by {name}
patch
Delete Passpoint profile.
del
Mesh
Read configuration of Mesh network topology
get
Create a new Mesh network profile
post
Read existing Mesh network profile
get
Update profile by {name}
patch
Delete the Mesh network profile
del
Ids
Read configured policies about IDS
get
Create a new policy
post
Read existing IDS configurations
get
Update profile by {name}
patch
Delete the IDS policy
del
Hotspot2 H2qp Oper Name
Read existing H2QP operator-friendly name related settings.
get
Create H2QP operator-friendly name profile.
post
Read existing H2QP operator-friendly name profile.
get
Update h2qp-oper-name-profile by {name}
patch
Delete H2QP operator-friendly name profile.
del
Hotspot2 H2qp Osu Provider
Read existing H2QP OSU provider related settings.
get
Create H2QP OSU provider profile.
post
Read existing H2QP OSU provider profile.
get
Update h2qp-osu-provider-profile by {name}
patch
Delete H2QP OSU provider profile.
del
Alg
Read alg
get
Create profile by {name}
post
Read profile by {name}
get
Update profile by {name}
patch
Delete profile by {name}
del
Hotspot2 Anqp 3gpp
Read existing ANQP 3GPP related settings.
get
Create ANQP 3GPP profile.
post
Read existing ANQP 3GPP profile.
get
Update anqp-3gpp-profile by {name}
patch
Delete ANQP 3GPP profile.
del
Hotspot2 Anqp Venue Name
Read existing ANQP venue information related settings.
get
Create ANQP venue information profile.
post
Read existing ANQP venue information profile.
get
Update anqp-venue-name-profile by {name}
patch
Delete ANQP venue information profile.
del
Wlan
Read configuration of WLAN SSID profile
get
Create a new WLAN SSID profile by unique name
post
Read existing WLAN SSID profile configuration
get
Update existing WLAN SSID profile configuration
patch
Delete the WLAN SSID profile
del
Radio
Read configured radios.
get
Create a new radio profile by unique name.
post
Read existing radio profile configurations.
get
Update profile by {name}
patch
Delete the radio profile.
del
Hotspot2 Anqp Ip Addr Avail
Read existing ANQP available IP address types related settings.
get
Create ANQP available IP address types profile.
post
Read existing ANQP available IP address types profile.
get
Update anqp-ip-addr-avail-profile by {name}
patch
Delete ANQP available IP address types profile.
del
Hotspot2 H2qp Conn Cap
Read existing hotspot protocol and port capabilities settings.
get
Create hotspot protocol and port capabilities profile.
post
Read existing hotspot protocol and port capabilities profile.
get
Update h2qp-conn-cap-profile by {name}
patch
Delete hotspot protocol and port capabilities profile.
del
Hotspot2 Anqp Nwk Auth
Read existing ANQP Network Authentication related settings.
get
Create ANQP network authentication profile.
post
Read existing ANQP Network Authentication profile.
get
Update anqp-nwk-auth-profile by {name}
patch
Delete ANQP network authentication profile.
del
Hotspot2 Anqp Roam Cons
Read existing ANQP Roaming Consortium OI information related settings.
get
Create ANQP Roaming Consortium OI information profile.
post
Read existing ANQP Roaming Consortium OI information profile.
get
Update anqp-roam-cons-profile by {name}
patch
Delete ANQP Roaming Consortium OI information profile.
del
Hotspot2 H2qp Oper Class
Read existing H2QP Operating Class related settings.
get
Create H2QP Operating Class profile.
post
Read existing H2QP Operating Class profile.
get
Update h2qp-oper-class-profile by {name}
patch
Delete H2QP Operating Class profile.
del
Hotspot2 H2qp Wan Metrics
Read existing H2QP WAN metrics related settings.
get
Create H2QP WAN metrics profile.
post
Read existing H2QP WAN metrics profile.
get
Update h2qp-wan-metrics-profile by {name}
patch
Delete H2QP WAN metrics profile.
del
Hotspot2
Read existing Hotspot2 related settings.
get
Create new Hotspot2 profile.
post
Read existing Hotspot2 profile.
get
Update hs-profile by {name}
patch
Delete Hotspot2 profile.
del
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!