Jump to Content

Home Guides API Reference Changelog

Guides API Reference GitHub Airheads Developer Community Log In

API Reference

Guides API Reference GitHub Airheads Developer Community Log In

Orchestrator REST APIs

acls
- Get Access lists settingsget
actionLog
alarm
apiKey
adminDistance
- Gets Admin Distance configurationsget
appliance
applianceBackup
applianceExtraInfo
bridgeInterfaceState
- Lists the Bridge Interfaces State and pass through Tx Interfaceget
networkRoleAndSite
- To verify or change a Network Role (hub / spoke) for appliancesget
- To verify or change a Network Role (hub / spoke) for appliances and to assign them to a sitepost
peerPriority
- Get all peer priority data on the applianceget
saveChanges
- Save the configuration changes in memory to a file for an array of appliances in Orchestratorpost
applianceResync
- Synchronize a list of appliances.post
appliancesSoftwareVersions
- Returns ECOS software versions informationget
applicationGroup
applicationDefinition
application
- Returns bandwidth stats about applicationsget
authentication
- Get the authentication order and authorization informationget
login
avcMode
- Returns Orchestrator avc Modeget
banners
- Lists the banner messages on each applianceget
bfd
- Get appliance BFD global level configuration data for specific VRF.get
- Get appliance BFD state information for all VRFs.get
bgp
brandCustomization
broadcastCli
- Broadcasts CLI commands to all the selected appliancespost
bypass
- Get bypass mode settings of one appliance in Orchestrator.get
- Toggles bypass mode - only effective on NX appliancespost
cache
- Get all built in applicationsget
- Gets the user applicationsget
saasOptimization
- Get SaaS Optimization configuration information for applianceget
- Get reachability/RTT values for SaaS App subnets enabled for advertisementget
awsCloudDeployment
azureCloudDeployment
gcpCloudDeployment
disks
- Get disks information.get
configurationLimit
- Get configuration limit data from the specified appliance.get
customApplianceTags
- Gets all users defined entriesget
customCerts
dbPartition
- Gets Orchestrator database partition detailsget
- Deletes the table's partitiondelete
debugFiles
deployment
dhcpConfig
vrfDnatMaps
- Gets Inter-Segment DNAT configurations of selected applianceget
dnsProxy
- Get the DNS proxy configget
exception
fileCreation
- This API is to be used with fineuploader.js plugin. See fineuploader.compost
flow
advancedProperties
appliancePreconfig
applianceCrashHistory
- This method is obsolete, no longer support this APIget
applianceRebootHistory
- Return or sends reboot history of all the appliancesget
applianceWizard
- Get the handle for the currently applying wizard.get
- Applies the wizard to an appliance in the backgroundpost
gmsBackup
discovery
- Returns the configuration for Discoveryget
- Updates the discovery configuration with the object passed. Note: Replaces the whole configuration with the configuration passedpost
dynamicTopologyConfig
- Returns the configuration for the dynamic topology tab.get
- Updates the dynamic topology configuration for the given userpost
gmsRegistration
grnode
group
gmsHttpsUpload
- upload the intermediate certs, certificate and key filespost
- Validate the certificate and keypost
interfaceLabels
internalSubnets
- Get the internal subnetsget
- Save internal subnetspost
ipAllowList
scheduledJobs2
overlayAssociation
overlays
gmsPermission
- Get the permission (read-write/read-only) of the user specified in userIdget
scheduleTimezone
- Returns the configured timezone for scheduled jobs and reportsget
- Updates the schedule timezone used with for the scheduled jobs and reports.post
services
sessionTimeout
- Returns information of auto logout and max login sessionget
- Update auto logout and max login sessionput
statsRetention
gmsStatsCollection
topologyConfig
gmsServer
gmsWizard
- /gms/wizardget
- Applies the wizard to an appliance in the backgroundpost
hostName
- Get the host name of orchestrator.get
gmsLicense
gmsRemoteAuth
gmsSMTP
haGroups
- Returns a collection of appliances paired in a HA configurationget
- Modify appliances paired in a HA configurationpost
health
vxoaHostname
- add/updates the gms hostnamepost
httpsCertificate
- Returns the HTTPS certificate on the specified applianceget
IdleTime
- Clear idle timeget
- Increment idle timeget
ikeless
inboundShaper
- Get inbound shapers settingsget
interfaceState
- Get node configuration data from Orchestrator database or from the specified appliance.get
ipObjects
license
linkAggregation
- Get all link aggregation data on the applianceget
linkIntegrity
- POST operation to start link integrity test between two appliances.post
- Operation to retrieve current link integrity test status for desired appliance.get
location
- Lookup the latitude,longitude of an addressget
logging
- Get logging settings form appliance or gmsdbget
session
- Returns all the current sessionsget
loopbackOrch
maintenanceMode
- Get maintenance mode appliancesget
- Set maintenance mode for appliancespost
maps
- Delete certain uploaded mappost
- Get list of uploaded mapsget
mgmtServices
- Gets Management Services configurations of selected applianceget
multicast
nat
natPolicy
netFlow
- Get flow export data from appliance or gmsdbget
networkMemory
- Erase Network Memory on one or more appliances.post
gmsNotification
optimizationPolicy
- Get route policy settingsget
ospf
overlayManagerProperties
pauseOrchestration
- Get all appliances' nePks which are paused from orchestrationget
- Set all appliances' nePks which are intended to be paused from orchestrationpost
portForwarding
- Get port forwarding rules on a ECOS.get
portProfiles
qosPolicy
- Get qos policy settingsget
rbacApplianceAccessGroup
rbacAssignment
rbacRole
rbacLegacyApi
reachability
- Get the reachability status from the applianceget
- Get the reachability status from the Orchestratorget
realtimeStats
- Get per second statistics from a ECOS appliancepost
regions
releases
remoteLogReceiver
dns
- Get the current DNS IP address and domain names configured for an appliance.get
restApiConfig
- Get the REST API configget
- Set the REST API configpost
restRequestTimeStats
- Returns summary of time used info of rest requests sent to appliancesget
- The time used details of all rest requests sent to an appliance's specific resource through portal web socket or web socketget
rmaWizard
- Applies the RMA wizardpost
routePolicy
- Get route policy settingsget
builtInPolicies
- Get built-in policy informationget
securitySettings
securityMaps
- Get Security Policies configured on the applianceget
activeSessions
- Returns all the current active sessionsget
- Delete certain sessionspost
shaper
- Get shapers settingsget
shell
- Gets shell access setting on Orchestratorget
- Sets shell access setting on Orchestratorpost
vrfSnatMaps
- Gets Inter-Segment SNAT configurations of selected applianceget
snmp
- Get SNMP information.get
spPortal
ssl
- Get all SSL certificates on the applianceget
sslCACertificate
sslSubstituteCert
- Validate the SSL Substitute certificatepost
- Get all SSL Substitute certificates on the appliance.get
aggregateStats
availabilityThresholdSettings
- Get availability threshold settingsget
- Set availability threshold settingspost
dnsInfo
- Get domain name by IP address from dns stats tableget
timeseriesStats
statsCollection
subnets
appSystemDeployInfo
- Get Appliance System Deployment Informationget
appSystemStateInfo
- Get Appliance System State Informationget
tca
- Get system threshold crossing alertsget
tcpdump
template
thirdPartyLicenses
- Gets all third party licenses informationget
thirdPartyServices
bondedTunnelsConfiguration
tunnelsConfiguration
thirdPartyTunnelsConfiguration
- Get the current list of tunnels statepost
- Search pass through tunnelsget
uiUsageStats
- Add usage count for one UI featurepost
upgradeAppliances
- Upgrade appliances with optionpost
- Check ECOS version compatibility for appliance upgrades through Portalpost
userAccount
- Gets all user details and sessions of applianceget
user
loopback
- Get loopback interface configuration on the applianceget
vti
- Get VTI interface configuration on the applianceget
vrf
vrrp
- Get a list of VRRP instances configured on the applianceget
applianceUpgrade
- Delete ECOS imagedelete
- Get ECOS imagesget
wccp
zones
availabilityTimeSettings
- Get availability time settings for provided appliance ids(NePk)post
- Post availability time settings for appliancespost
applianceCPUstats
ScheduledPDFreports
- Returns list of schedule reportsget
idps
Orchestrator High Availablability
vxlan
- Returns common VXLAN settingsget
- Returns vrf and vni mapget
StatsDebug
- Get all StatisticsP99 entriesget

Silver Peak Unity ECOS REST APIs

login
ipObjects
scalars
- Get the VXOA scalars.get
statistics
flows
alarm
cnprocess
- state of processget
managementInterface
- Get the management interface address.get
- Set management interface addresspost
license
deployment
networkInterfaces
- Get appliance's network interface information.get
- Set appliance's network interface configuration.post
networkRoutes
- Get appliance's management/LAN network routes and WAN next-hops information.get
- Set appliance's management and LAN network routes configuration.post
nexthops
- Get appliance's data path next hops information.get
vrrp
wccp
localSubnets
tunnel
bondedTunnel
thirdPartyTunnel
routePolicy
optimizationPolicy
qosPolicy
shaper
inboundShapers
trafficClass
- Get the traffic names.get
- Modify the traffic names.post
natPolicy
peers
- Get the peers of current appliance.get
- Get the silver peak peers of current appliance.get
acls
userDefinedApplications
applicationGroups
log
flowRedirection
systemInfo
- Get system information on the appliance.get
proxyInfo
- Get Proxy information of the appliance.get
system
saasOptimization
tcpdump
dns
- Get the current DNS IP address and domain names configured for your appliance.get
- Modify DNS IP address and domain names configured for your appliance.post
linkIntegrity
reboot
spPortal
internetDatabase
netFlow
saveChanges
- Save the changes in memory to a file in the appliance.post
snmp
builtInApps
- Returns built-in applicationsget
- Returns built-in applications along with their portsget
dateTimeNtp
- Get the current Date/Time settings.get
- update the current Date/Time settings.post
hostname
- Get the Hostname of the Appliance.get
- Set the Hostname of the Appliance. This requires a manual restart of nodejspost
networkMemory
- Erase network memorypost
hello
- Get the host name of appliance.get
webconfig
- Gets the web Server Session Management Attributes.get
- Modifies the web Server Session Management Attributes. Must restart nodejs manually.post
uploadFile
- uploads the file from local diskpost
bypass
- Returns info about current bypass mode settingsget
- Toggles bypass mode - only effective on NX appliancespost
authentication
gms
debugFiles
diskUsage
- Get the disk usage of the appliance.get
softwareUpgrade
time
- Get current time on the appliance.get
banners
- Get the current login banner and message of the day.get
- Modify the current login banner and message of the day.post
tca
logViewer
- Get date range of the specified type log fileget
- Get a certain type of log file content.get
disks
- Returns disks information about this appliance.get
- Insert into or remove from this appliance some disk or disks.post
pingTrace
sslCerts
sslSubstituteCert
sslCACerts
configdb
users
eventManagement
cli
- Run single cli command on the appliancepost
- Run multiple cli commands on the appliancepost
sysLimits
interfaces
- Get interface related information.get
- Get a specific interfaces attributeget
memory
- Get memory info on the appliance.get
fileOps
- Upload, download or delete a filepost
thirdPartyLicenses
- Gets all third party licenses informationget
interfaceLabels
overlays
dhcpd
bgp
httpsCertsUpload
topSites
- Get list of top internet sitesget
tcpUdpPorts
- Get TCP/UDP ports dataget
ipProtocolNumbers
- Get list of IP Protocol Numbersget
backtrace
- Get the crash info of this appliance.get
peerPriorityList
peerPriorityList2
statsConfig
- Get stats config of this appliance.get
- Set stats config of this appliance.post
internalSubnets
- Get the internal subnetsget
- Save internal subnetspost
pppoe
ipSla
applicationDefinition
urlDownload
dnsCache
- Gets DNS Cache configurationsget
- POSTs DNS Cache configurationspost
ipsecUdp
- Get the IPSEC UDP local and peer portsget
- Configure IPSEC UDP Portspost
adminDistance
- Get the admin distance config of current appliance.get
- Modify the admin distance config of current appliance.post
portForwarding
tunGlobalConfig
- Get the current global configuration for tunnelget
- Update the current global configuration for tunnelpost
xcvr
- Get transceiver status for a 10Gig interfaceget
ospf
zones
securityMaps
builtInPolicies
- Get current built-in policiesget
runningConfig
nslookup
regions
multicast
nat
loopback
vti
dnsProxy
- Get the DNS proxy configget
- Modify the DNS proxy configpost
mgmtServices
- Get the management services data of current appliance.get
- Modify the management services config of current appliance.post
redistRouteMaps
- Get current redistribution Mapsget
- Post list of route redistribution maps.post
customApplianceTags
- Gets all users defined entriesget
- add/updates users defined entriespost
security
ikeless
vrfZonesMap
- Returns vrf firewall zones mapget
- Add/Edit vrf firewall zones mappost
vrfs
idsips
customCaCerts
linkAggregation
bfd
swaggerDocsConfig
- Get the configuration details of the swagger documentation.get
cpu
- returns the CPU usage data in JSON queue format for the past 5 minutes, or since the specified time parameter in request, as well as a timestamp with the current timeget
SessionAffinityConfig
- set session affinity configpost
- returns session affinity configurationget

Notes captured for alarms whose sequence IDs are provided

post http://localhost:3001/rest/json/alarm/note

Language

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