Jump to Content
Home
Guides
API Reference
Changelog
AOS 8
AOS-CX
Central
New Central
New Central - Configuration API
ClearPass Policy Manager
User Experience Insight
Fabric Composer
EdgeConnect SD-WAN
v0.0.0
v1.0.0
v9.3
Guides
API Reference
GitHub
Airheads Developer Community
Log In
API Reference
Guides
API Reference
GitHub
Airheads Developer Community
Log In
EdgeConnect SD-WAN
API - v9.3
API Reference
Gets the web Server Session Management Attributes.
JUMP TO
Orchestrator REST APIs
acls
Get Access lists settings
get
actionLog
Get action/audit log entries.
get
Cancel action guid key
post
Get status of a particular action using guid key
get
Are there any overlay actions in progress
get
alarm
Acknowledges alarms on appliance whose sequence IDs are provided in the request body
post
Acknowledges alarms whose IDs are provided in the request body
post
Get alarms configuration
get
Update alarms configuration
post
Returns active, historical, or all alarms for appliances whose ids provided in the request body
post
Clears alarms whose sequence IDs are provided in the request body
post
Clears alarms whose IDs are provided in the request body
post
Returns summary of active alarms for the appliance
get
Delete all or specified customized alarm severity
del
Get all or specified customized alarm severity
get
Create customized alarm severities
post
Update customized alarm severities
put
Delete alarm email delay configuration
del
Get alarm email delay configuration
get
Create alarm email delay configuration
post
Update alarm email delay configuration
put
Get Orchestrator and appliance alarm descriptions
get
Returns active, closed/historical, or all Orchestrator alarms
get
Capture comments for alarms on appliance whose sequence IDs are provided in the request body
post
Capture Comments for alarms whose IDs are provided in the request body
post
Returns alarm notification
get
Set alarm notification
post
(1) Returns summary of active Orchestrator alarms or summary of active alarms across all appliances (2) Returns summary of active Orchestrator alarms as well as summary of active alarms across all appliances
get
Delete disabled alarms configuration
del
Get all disabled alarms configuration
get
Update disabled alarms configuration
post
apiKey
Get list of all API keys
get
Add new API key
post
Delete API key entry
del
Update API key entry
put
adminDistance
Gets Admin Distance configurations
get
appliance
Get the all approved appliances
get
Change one or more appliances' group
post
Change a user's password on appliance.
post
To get cached custom tag list for all appliances.
get
Delete for rediscovery.
del
Get the all denied appliances
get
Delete denied appliances.
post
Returns the all discovered appliances
get
Add discovered appliances to Orchestrator
post
Add and approve discovered appliances.
post
Delete discovered appliances.
del
Deny discovered appliances.
post
Trigger discovered appliances update
put
Gets DNS Cache configurations
get
To get cached HA peer data for all appliances.
get
To get cached interface list for all appliances.
get
Lists appliances ( appliance primary keys) that are queued on the Orchestrator for deletion.
get
Discover denied appliance.
post
To communicate with appliance DELETE APIs directly.
del
To communicate with appliance GET APIs directly.
get
To communicate with appliance POST APIs directly.
post
To get stats config which will be synchronized to appliances.
get
To modify stats config which will be synchronized to appliances.
post
To get default stats config which will be synchronized to appliances.
get
To get cached zone list for all appliances.
get
Delete an appliance from network.
del
Get appliance information
get
Modify an appliance's IP address, username, password, networkRole, and webProtocol.
post
applianceBackup
Backup appliance configuration to Orchestrator database
post
Delete one specified backup record from the database table.
del
Get backup history.
get
Restore the appliance from the specified back.
post
applianceExtraInfo
Delete the extra information of an appliance
del
Get the extra information of an appliance
get
Saves the extra information for the appliance
post
bridgeInterfaceState
Lists the Bridge Interfaces State and pass through Tx Interface
get
networkRoleAndSite
To verify or change a Network Role (hub / spoke) for appliances
get
To verify or change a Network Role (hub / spoke) for appliances and to assign them to a site
post
peerPriority
Get all peer priority data on the appliance
get
saveChanges
Save the configuration changes in memory to a file for an array of appliances in Orchestrator
post
applianceResync
Synchronize a list of appliances.
post
appliancesSoftwareVersions
Returns ECOS software versions information
get
applicationGroup
Get all built-in and user-defined applications
get
Get all built-in applications from all appliance
get
Get all userDefined applications from all appliance
get
Get all user-defined application group on appliance
get
Get all applicationGroups on a appliance
get
applicationDefinition
Returns user defined AppExpress application configurations
get
Create user defined application AppExpress application config
post
Returns AppExpress group configurations
get
Create/Modify AppExpress group config
post
Deletes AppExpress group
del
Returns AppExpress group associations
get
Create/Modify AppExpress group config
post
return user defined application groups
get
(1) Create user defined application groups (2) Change mode to application groups and user defined applications
post
Search application groups based on wildcard and limit
post
Search applications based on wildcard and limit
post
return user defined data for Compound classification
get
Change the order of user defined application related to Compound data
post
Delete user defined application related to Compound data
del
Create/modify user defined application related to Compound data
post
Delete user defined application related to Domain Name
del
Create/modify user defined application related to Domain Name
post
Delete user defined application related to Domain Name
post
Create/modify user defined application related to Domain Name
post
Delete user defined application related to Address Map
del
Create/modify user defined application related to Address Map
post
Create/modify user defined application confidence to override portal provided Address Map for named apps
post
Delete user defined confidence value for the named application
del
Retrieve user defined confidence value for the named application
get
Delete user defined application related to Meter Flow
del
Create/modify user defined application related to Meter Flow
post
Delete user defined application related to IP Protocol, TCP Port, UDP Port
del
Create/modify user defined application related to IP Protocol, TCP Port, UDP Port
post
Delete user defined application related to SaaS data
del
Create/modify user defined application related to SaaS data
post
Retrieve the modification times, and hash codes of application and group definitions
get
application
Returns bandwidth stats about applications
get
authentication
Get the authentication order and authorization information
get
login
Used to login via JWT authentication
get
Authentication for REST API HTTP Session
post
Get the current authentication status of the HTTP session
get
Send a 2-factor code to user's mailbox for 2-factor authentication
post
Logout of current HTTP session
get
Login to Orchestrator using Oauth server
get
Returns the Oauth state token needed to login
get
Authenticate user's password only, but doesn't mark user's status as login
post
Use to authenticate via SAML
post
Logout of Orchestrator via SAML
get
Check the two factor authentication methods the user requires to login
post
Check the two factor authentication methods the user has active using a reset password token
post
avcMode
Returns Orchestrator avc Mode
get
banners
Lists the banner messages on each appliance
get
bfd
Get appliance BFD global level configuration data for specific VRF.
get
Get appliance BFD state information for all VRFs.
get
bgp
Get all vrf neighbors configuration data.
get
Get All vrf BGP system configuration data.
get
Get specific neighbor configuration data.
get
Get BGP system configuration data.
get
Get all vrf bgp state details.
get
Get specific appliance bgp state details.
get
brandCustomization
Delete all text brand customization configurations
del
Get text brand customization configurations
get
Create new text brand customization configurations
post
Update text brand customization configurations
put
Return file names for all the uploaded images
get
Delete image for given type of brand customization and restore default
del
Upload image for given type of brand customization
post
Update image for given type of brand customization
put
broadcastCli
Broadcasts CLI commands to all the selected appliances
post
bypass
Get bypass mode settings of one appliance in Orchestrator.
get
Toggles bypass mode - only effective on NX appliances
post
cache
Get all built in applications
get
Gets the user applications
get
saasOptimization
Get SaaS Optimization configuration information for appliance
get
Get reachability/RTT values for SaaS App subnets enabled for advertisement
get
awsCloudDeployment
Add AWS account for deployment
post
Delete AWS account by id
del
Get AWS account
get
Update AWS account
put
Deploy Cloud Hub(s) in AWS
post
Destroy deployed appliances by deployment id
del
Get AWS Cloud Hub deployment config by id
get
Update comment of a deployment
put
add instance in an existing aws cloud deployment
post
Get AWS Cloud Hub deployment log
get
Get AWS Cloud Hub deployment cloud resources info
get
Get AWS Cloud Hub deployment status
get
azureCloudDeployment
Add Azure account for deployment
post
Delete Azure subscription by id
del
Get single Azure subscription by id
get
Update Azure subscription
put
Deploy Cloud Hub(s) in Azure
post
Destroy deployed appliances by deployment id
del
Get Azure Cloud Hub deployment config by id
get
Update comment of a deployment
put
add instance in an existing azure cloud deployment
post
Get Azure Cloud Hub deployment log
get
Get Azure Cloud Hub deployment cloud resources info
get
Get Azure Cloud Hub deployment status
get
gcpCloudDeployment
Add gcp account for deployment
post
Delete gcp account by id
del
Get single gcp account by id
get
Update gcp account
put
Update gcp instance comment
put
Add instance(s) in an existing deployment
post
Destroy deployed appliance
del
Deploy Cloud Hub(s) in GCP
post
Destroy deployed appliances by deployment
del
Get GCP Cloud Hub deployment config by id
get
Get GCP Cloud Hub deployment log
get
Get gcp Cloud Hub deployment cloud resources info
get
Get gcp Cloud Hub deployment status
get
disks
Get disks information.
get
configurationLimit
Get configuration limit data from the specified appliance.
get
customApplianceTags
Gets all users defined entries
get
customCerts
Get list of all custom CA certificates
get
Add new or update existing custom CA certificate
post
Delete custom CA certificate
del
Checks whether appliances can connect to Portal and Orchestrator using the default or custom CA certificates
post
Returns whether or not Orchestrator is currently using custom CA certificate trust store
get
Enable or disable custom CA certificate trust store
post
Checks whether Orchestrator can connect to Portal using the default or custom CA certificates
post
Verify the custom CA certificate
post
Get list of all default CA certificates
get
dbPartition
Gets Orchestrator database partition details
get
Deletes the table's partition
del
debugFiles
Cancel download the file
post
Delete the Orchestrator or appliance debug file
post
Get the proxy config settings
get
Set the proxy config settings
post
Get the debug files
get
deployment
Validate deployment configuration
post
Validate deployment configuration for a discovered appliance.
post
Get the deployment configuration of the appliance, does a direct call to the appliance.
get
Get the deployment configuration of the appliance.
get
dhcpConfig
Get orchestrator DHCP settings
get
Save orchestrator DHCP settings
post
Get DHCP leases information.
get
Get list of reserved subnets from the DHCP pool
get
Reserve a subnet in the DHCP pool
post
Update DHCP pool reservations list. This api can be used to clear up local reservations (that have not been configured on appliance yet)
post
Remove all DHCP pool reservations
post
Get dhcpd leases report of failover state
get
vrfDnatMaps
Gets Inter-Segment DNAT configurations of selected appliance
get
dnsProxy
Get the DNS proxy config
get
exception
Get all tunnel exceptions
get
Create tunnel exceptions
post
Delete tunnel exceptions for given ids
post
fileCreation
This API is to be used with fineuploader.js plugin. See fineuploader.com
post
flow
Returns the so far accumulated bandwidth stats about the flow
get
Returns flow details
get
Returns more detailed info about the flow
get
Reclassifies the flow(s)
post
Resets the flow(s)
post
Returns flow optimization details
get
Enable or disable flow alerting
post
Returns active, inactive, or both types of flows on the appliance based on the query parameters supplied
get
advancedProperties
Get Orchestrator advanced properties
get
Update Orchestrator advanced properties
put
Get Orchestrator metadata of the advanced properties
get
appliancePreconfig
Get preconfigurations
get
Create a preconfiguration
post
Update preconfiguration given by preconfigId
put
Delete one preconfiguration
del
Get the default preconfiguration, this contains the template YAML which has all possible configuration items. You will have to base64 decode configData to see the YAML in plain text
get
Get the first matching preconfiguration, matching by serial then tag
post
Validate the preconfig given as request body
post
Get the appliance information that is relevant for preconfiguration
get
Get the apply status of a preconfiguration
get
Apply preconfiguration to an already managed appliance
post
Apply preconfiguration to discovered appliance
post
applianceCrashHistory
This method is obsolete, no longer support this API
get
applianceRebootHistory
Return or sends reboot history of all the appliances
get
applianceWizard
Get the handle for the currently applying wizard.
get
Applies the wizard to an appliance in the background
post
gmsBackup
Returns orchestrator backup information
get
add or update orchestrator backup config data
post
Create blueprint template
get
Test the orchestrator backup remote server whether can connect.
post
discovery
Returns the configuration for Discovery
get
Updates the discovery configuration with the object passed. Note: Replaces the whole configuration with the configuration passed
post
dynamicTopologyConfig
Returns the configuration for the dynamic topology tab.
get
Updates the dynamic topology configuration for the given user
post
gmsRegistration
Gets setting for GMS registration on appliance
get
update setting for GMS registration on appliance
post
Gets setting for GMS registration on appliance
get
update setting for GMS registration on appliance
post
grnode
Get appliance positions on a map for topology
get
Update appliance position
post
Update appliance position by nePk
post
group
Add new group
post
Get root group
get
Delete a group
del
Get a single group
get
Update a group
post
gmsHttpsUpload
upload the intermediate certs, certificate and key files
post
Validate the certificate and key
post
interfaceLabels
Returns all the labels for the given type
get
Save interface labels, will completely replace the current implementation.
post
Pushes the active interface labels on Orchestrator to appliance
post
internalSubnets
Get the internal subnets
get
Save internal subnets
post
ipAllowList
Get the IP addresses of the dropped requests to this server
get
Get the external IP/mask allow list
get
Set the external IP/mask allow list
post
scheduledJobs2
Get all the scheduled jobs in Orchestrator
get
Schedule a new job in Orchestrator
post
Deletes a schedule job
del
Modify a scheduled job.
put
Get the historical jobs by parameter. If all parameter is empty. Get 1000 latest historical jobs entities.
get
Get the report view port.
get
Update the report view port.
post
Stop a scheduled job
post
Get the historical stats collector jobs by parameter. If all parameter is empty. Get 1000 latest historical jobs entities.
get
Get all the scheduled jobs in stats collector
get
Delete stats collector jobs by job category and job id.
del
overlayAssociation
Remove appliances from overlays
post
Get appliances in an overlay
get
Add appliances to overlays
post
Remove an appliance from an overlay
del
overlays
Get the max number of overlays
get
Post regional overlay configurations
post
Get regional overlay by overlayId and regionId
get
Modify regional overlay
put
Saves a new overlay to the Orchestrator
post
Deletes the overlay from the Orchestrator. Removes any appliances from the overlay and deletes any reports specifically for this overlay.
del
Returns one overlay that has the id of the passed overlayId parameter
get
Update the properties of an existing overlay
put
Get the overlay priority order
get
Change the overlay priorities
post
gmsPermission
Get the permission (read-write/read-only) of the user specified in userId
get
scheduleTimezone
Returns the configured timezone for scheduled jobs and reports
get
Updates the schedule timezone used with for the scheduled jobs and reports.
post
services
Returns all the services
get
Save the service list
post
Returns all the Third Party Services
get
sessionTimeout
Returns information of auto logout and max login session
get
Update auto logout and max login session
put
statsRetention
Get Approximate Disk Space for stats.
get
Enable/Disable Stats collection for Statistics
put
Get Stats collection Enable/Disable info.
get
Update Non Statistics Retention details
put
Get all Non Statistics Retention details.
get
Update Statistics Retention details
put
Get all Statistics Retention details.
get
Returns Orchestrator Stats Retention notification boolean flag value
get
Update Orchestrator Stats Retention notification boolean flag value
post
gmsStatsCollection
Gets stats collection enable/disable details
get
Used to enable/disable stats collection by orchestrator
post
To get default values for stats collection
get
topologyConfig
Returns the configuration for the topology tab. The key in the configuration will be the username.
get
Updates the topology configuration for the given user
post
Returns topology info in csv format.
get
Returns topology info in csv format.
post
Returns overlay tunnel's topology info for given nePks in csv format.
post
Returns passthrough tunnel's topology info for given nePks in csv format.
post
Returns underlay tunnel's topology info for given nePks in csv format.
post
/gms/topologyConfig/linkInfo
get
Update the map image
post
gmsServer
Returns available orchestrator versions
get
Returns Orchestrator Operating system type
get
Returns Orchestrator Disk Space notification boolean flag value
get
Update Orchestrator Disk Space notification boolean flag value
put
Returns Orchestrator Root Password Changed notification boolean flag value
get
Update Orchestrator Root Password Changed notification boolean flag value
post
Returns orchestrator server brief information such as up time, release, timeZone, container mode etc...
get
Returns hello message.
get
Returns orchestrator server information such as used disk space, hostname,release etc...
get
Returns orchestrator server information such as hostname, up time, version, dbHelth, message etc...
get
gmsWizard
/gms/wizard
get
Applies the wizard to an appliance in the background
post
hostName
Get the host name of orchestrator.
get
gmsLicense
Get current license key and information
get
Set Orchestrator license key
post
Validate a new license key
get
Retrieves in-memory AAS licensing runtime stats
get
Retrieves current license usage for features that are enforced by AAS license tokens
get
Retrieves AAS license limits (for display purposes only)
get
gmsRemoteAuth
Get current configured RADIUS, TACACS+ or OAuth servers configuration
get
Get all current configured JWT configurations
get
Create a new JWT config. Returns the ID of the new config
post
Delete JWT configuration matched to the JWT name
del
Update JWT configuration matched to the JWT name
put
Get all current configured OAuth servers configuration
get
Create a new OAuth server config
post
Delete OAuth servers configuration matched to the id
del
Update OAuth servers configuration matched to the id
put
Delete RADIUS server config
del
Get RADIUS server config if it exists
get
Create or update RADIUS server config
post
Get all currently configured SAML servers with serverId and it's configuration
get
Create a new SAML server configuration
post
Delete SAML server configuration matched to the id
del
Update SAML servers configuration matched to the server Id
put
Delete TACACS+ server config
del
Get TACACS+ server config if it exists
get
Create or update TACACS+ server config
post
Get available light versioned login type
get
gmsSMTP
Gets SMTP details
get
used to set SMTP settings
post
Delete unverified emails
post
Send a verification email to an email address
post
used to send test mail
post
Get unverified email addresses
get
verify an email address
get
haGroups
Returns a collection of appliances paired in a HA configuration
get
Modify appliances paired in a HA configuration
post
health
Returns health summary of all appliances
post
Returns summary of alarms for a given appliance for that time period
get
Returns health threshold config
get
Update health threshold configuration
post
Returns summary of jitter for a given appliance for that time period
get
Returns summary of latency for a given appliance for that time period
get
Returns summary of loss for a given appliance for that time period
get
Returns summary of mos for a given appliance for that time period
get
vxoaHostname
add/updates the gms hostname
post
httpsCertificate
Returns the HTTPS certificate on the specified appliance
get
IdleTime
Clear idle time
get
Increment idle time
get
ikeless
GET Ikeless key material configuration, seed lifetime, max activation wait time, whether persist seed
get
Change Ikeless key material configuration, seed lifetime, max activation wait time, whether persist seed
post
Get UDP IPSec key status history on orchestrator
get
Get UDP IPSec key status for all appliances
get
Get UDP IPSec key status for an appliances
get
inboundShaper
Get inbound shapers settings
get
interfaceState
Get node configuration data from Orchestrator database or from the specified appliance.
get
ipObjects
Upload a CSV file for bulk upload. The API returns the status and a list of groups that got imported.
post
trigger an immediate merge of address groups
post
Removes an ACL group object
del
return ACL group object
get
Create/Replace an ACL address group object
post
Replace an ACL address group object
put
(1) Returns all ACL service group objects (2) Returns an ACL service group object
get
Create/Replace an ACL service group object
post
Replace an ACL service group object
put
Delete an ACL service group object
del
Upload a CSV file for bulk upload. The API returns the status and a list of groups that got imported.
post
trigger an immediate merge of service groups
post
Get an estimate of the memory that would be consumed by the configuration type.
get
license
Retrieves license Management Settings
get
Retrieves NX licensed appliances
get
Retrieves portal licensed appliances
get
Grant an appliance a base license via Cloud Portal
post
Delete an appliance's license token via the appliance
del
Revoke an appliance a base license via Cloud Portal
post
Changes ec appliance license settings
post
Changes ec appliance account and license settings
post
Retrieves portal account license summary
get
Retrieves portal account license summary for primary and secondary accounts
get
Get the appliance's account by nePk
get
Get the discovered appliance's account by discoveredId
get
Retrieves VX licensed appliances
get
linkAggregation
Get all link aggregation data on the appliance
get
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 address
get
logging
Get logging settings form appliance or gmsdb
get
session
Returns all the current sessions
get
loopbackOrch
Get loopback orchestration setting
get
Set loopback orchestration setting
post
Get loopback pool allocation info
get
Get loopback pool history by segment
get
Reclaim all deleted ip addresses or Reclaim deleted ip address by id
del
Reclaim deleted ip addresses by Segment ID
del
maintenanceMode
Get maintenance mode appliances
get
Set maintenance mode for appliances
post
maps
Delete certain uploaded map
post
Get list of uploaded maps
get
mgmtServices
Gets Management Services configurations of selected appliance
get
multicast
Get multicast config info on the appliance
get
Get multicast enabled info on the appliance
get
Get multicast interface state info on the appliance
get
Get multicast neighbor state info on the appliance
get
Get multicast route state info on the appliance
get
nat
Returns all NAT Config
get
Get NAT Maps
get
Returns all NAT Pools
get
natPolicy
Get NAT all inbound/outbound settings
get
Get NAT policy settings
get
Get dynamic NAT rules settings
get
netFlow
Get flow export data from appliance or gmsdb
get
networkMemory
Erase Network Memory on one or more appliances.
post
gmsNotification
Remove the message of notification banner.
del
Get the message of notification banner.
get
Add or update the message of notification banner.
post
optimizationPolicy
Get route policy settings
get
ospf
Get all segments OSPF Interfaces configurations.
get
Get all segments system level OSPF configuration.
get
Get appliance's OSPF areas configuration data.
get
Get OSPF interfaces configuration data.
get
Get appliance's OSPF system level configuration data.
get
Gets all segments OSPF interfaces state.
get
Gets all segments OSPF neighbors state.
get
Gets all segments OSPF state.
get
Gets the state of the OSPF interfaces.
get
Gets the state of the OSPF neighbors.
get
Gets the state of the OSPF.
get
overlayManagerProperties
Get the overlay manager properties in the Orchestrator.
get
Set the overlay manager properties in the Orchestrator.
post
Get the default overlay manager properties in the Orchestrator.
get
pauseOrchestration
Get all appliances' nePks which are paused from orchestration
get
Set all appliances' nePks which are intended to be paused from orchestration
post
portForwarding
Get port forwarding rules on a ECOS.
get
portProfiles
Delete a Deployment Profile template matching the id
del
Get a Deployment Profile template matching the id
get
Create a new Deployment Profile template
post
Update a Deployment Profile template matching the id
put
Check if an interface label is in use by any of the existing deployment profiles
get
qosPolicy
Get qos policy settings
get
rbacApplianceAccessGroup
Get all appliance access groups / assets
get
Create or update appliance access group / asset.
post
Delete appliance access group / asset by name
del
rbacAssignment
Delete rbacAssignment by username
del
Get rbacAssignment by username
get
Create or update rbacAssignment.
post
rbacRole
Get all roles.
get
Create role or Update existing role.
post
Delete role By name. If role is assigned to one or more users then API will return HTTP 423
del
Get list of accessible menus
get
rbacLegacyApi
Get list of all legacy APIs
get
Add new legacy API
post
Update legacy API
put
Delete legacy API
del
reachability
Get the reachability status from the appliance
get
Get the reachability status from the Orchestrator
get
realtimeStats
Get per second statistics from a ECOS appliance
post
regions
Get region association
get
Create region association
post
Update region association
put
Get region association by region ID
get
Delete region by regionId
del
Get region by regionId
get
Update regions
put
Create region
post
releases
Gets all the Releases for orchestrator and ecos
get
Get release notifications
get
Delay a release notification
post
Dismiss a release notification
post
remoteLogReceiver
Get a remote log receiver
get
Add remote log receiver(s) with configuration provided in the request body
post
Update remote log receiver(s) with data provided in the request body
put
Delete a remote log receiver
del
To get all websocket receiver connection status
get
Get latest alarm or audit log event sequence id
get
To query specific log(s) with log type and sequence id(s) provided in the request body
post
dns
Get the current DNS IP address and domain names configured for an appliance.
get
restApiConfig
Get the REST API config
get
Set the REST API config
post
restRequestTimeStats
Returns summary of time used info of rest requests sent to appliances
get
The time used details of all rest requests sent to an appliance's specific resource through portal web socket or web socket
get
rmaWizard
Applies the RMA wizard
post
routePolicy
Get route policy settings
get
builtInPolicies
Get built-in policy information
get
securitySettings
Returns advanced security settings
get
Configure advanced security settings
post
Returns protection profiles
get
securityMaps
Get Security Policies configured on the appliance
get
activeSessions
Returns all the current active sessions
get
Delete certain sessions
post
shaper
Get shapers settings
get
shell
Gets shell access setting on Orchestrator
get
Sets shell access setting on Orchestrator
post
vrfSnatMaps
Gets Inter-Segment SNAT configurations of selected appliance
get
snmp
Get SNMP information.
get
spPortal
Number of times account key has been changed
get
Current account key change status
get
Request Portal to generate a new account key
put
Delete old account key from Portal
del
Assign EC-SP licenses on Portal
post
Get EC-SP licenses from Portal
get
Unassign EC-SP licenses on Portal
post
Get account license feature from Portal
get
Get account license type from Portal
get
Test if appliance is reachable via websocket from orchestrator
get
Get application groups from portal
get
Returns user defined AppExpress application configurations
get
Get the hash code for application groups data from portal
get
Get Broadcast Message from Silver Peak Portal
get
Get application definition for Compound data from portal
get
Get the hash code for application definition data for Compound data from portal
get
Get Silver Peak Cloud Portal registration information
get
Post Silver Peak Cloud Portal registration information
post
Post Silver Peak Cloud Portal registration information for secondary accounts. Note: This replaces the entire existing secondary accounts configuration with the configuration passed
post
Get Orchestrator to Silver Peak Portal connectivity status
get
Get Orchestrator to Portal connectivity status
get
Get Appliance to Portal connectivity status
get
Create a case
post
Get application definition for Domain Name from portal
get
Get the hash code for application definition data for Domain Name from portal
get
Get geolocation information for a single ip from portal
get
Get geolocation information for multiple ip's from portal
post
Get application definition data for Address Map from portal
get
Get the last update time for application definition data for Address Map from portal
get
Search application definition data for Address Map from portal
get
Get count for application definition data for Address Map from portal
get
Get service id to service details mapping
get
Get count of internet services on this appliance
get
Get a list of unique countries in the internet services database
get
Get a list of unique saas applications in the internet services database
get
Get IP Protocol Numbers data
get
Get application definition for Meter Flow from portal
get
Get the hash code for application definition data for Meter Flow from portal
get
Get application definition for IP Protocol, TCP Port, UDP Port from portal
get
Get the hash code for application definition data for IP Protocol, TCP Port, UDP Port from portal
get
Get current GMS-Portal registration status
get
Initiate GMS-Portal Registration
post
Get current GMS-Portal registration status for secondary accounts
get
Initiate GMS-Portal Registration for secondary accounts
post
Get application definition for SaaS data from portal
get
Get the hash code for application definition data for SaaS data from portal
get
Debug API to view current status of all Portal related services
get
Get TCP/UDP ports data
get
Get list of top internet sites
get
Get traffic behavior categories from portal
get
Get the hash code for traffic behavior categories data from portal
get
Get Zero Touch Provisioning information from Silver Peak Portal
get
Post Zero Touch Provisioning information to Silver Peak Portal
post
ssl
Get all SSL certificates on the appliance
get
sslCACertificate
This API will take certificate date and return certificate information in text
post
Validate the SSL CA certificate file.
post
Get all CA SSL certificates on the appliance.
get
This API will take certificate date and return certificate information
post
This API will take certificate date and return certificate information in text
post
sslSubstituteCert
Validate the SSL Substitute certificate
post
Get all SSL Substitute certificates on the appliance.
get
aggregateStats
Get aggregate appliance stats data for a single appliance filter by query parameters.
get
Get aggregate appliance stats data filter by query parameters.
post
Get aggregate application stats data for a single appliance filter by query parameters
get
Get aggregate application stats data filter by query parameters
post
Get aggregate application stats data for a single appliance filter by query parameters
get
Get aggregate application stats data filter by query parameters
post
Get tunnel availability aggregate stats for a single appliance filter by query parameters
get
Get network role availability aggregate stats for all appliance in network
get
Get interface availability aggregate stats for all appliance in network
get
Get aggregated stats of appliance reachability for the selected appliance in network
get
Get tunnels availability for third party services
get
Get aggregate boost stats data for a single appliance filter by query parameters
get
Get aggregate boost stats data
post
Get aggregate dns stats data for a single appliance filter by query parameters.
get
Get aggregate dns stats data filter by query parameters.
post
Get aggregate tunnel drc stats data for a single appliance filter by query parameters.
get
Get aggregate tunnel drc stats data filter by query parameters.
post
Get aggregate dscp stats data for a single appliance filter by query parameters
get
Get aggregate dscp stats data filter by query parameters
post
Get aggregate flow stats data for a single appliance filter by query parameters
get
Get aggregate flow stats data filter by query parameters
post
Get active flow counts by NE id
post
Get aggregate interface stats data
post
Get aggregate interface overlay transport stats data
post
Get aggregate jitter stats data filter by query parameters.
post
Get aggregate jitter stats data filter by query parameters.
get
Get aggregate Mean Opinion Score stats data
get
Get aggregate Mean Opinion Score stats data
post
Get aggregate ports stats data filter by query parameters.
get
Get aggregate ports stats data filter by query parameters.
post
Get aggregate security policy stats data
get
Get aggregate security policy stats data
post
Get aggregate topTalkers stats data for a single appliance filter by query parameters.
get
Get aggregate topTalkers stats data filter by query parameters.
post
Get aggregate topTalkers stats data for a single appliance filter by query parameters.
get
Get aggregate Traffic Behavioral stats data filter by query parameters
get
Get aggregate Traffic Behavioral stats data for a single appliance filter by query parameters
post
Get aggregate trafficClass stats data for a single appliance filter by query parameters
get
Get aggregate traffic class stats data filter by query parameters
post
Get aggregate tunnel stats data for a single appliance filter by query parameters.
get
Get aggregate tunnel stats data filter by query parameters.
post
Get aggregate application stats data filter by query parameters
post
Get aggregate application stats data filter by query parameters
post
Get aggregate user stats data filter by query parameters
post
Get aggregate user stats data filter by query parameters
post
Get aggregate dns stats data filter by query parameters.
post
Get aggregate interface overlay transport stats data
post
Get aggregate Mean Opinion Score stats data
post
Get aggregate overlay bandwidth stats data filter by query parameters
post
Get aggregate ports stats data filter by query parameters.
post
Get aggregate shaper stats data
post
Get aggregate topTalkers stats data filter by query parameters.
post
Get aggregate tunnel stats data filter by query parameters.
post
Get aggregate tunnel stats data filter by query parameters.
post
Get aggregate tunnel stats data filter by query parameters.
post
Get aggregate topTalkers destination stats data.
post
availabilityThresholdSettings
Get availability threshold settings
get
Set availability threshold settings
post
dnsInfo
Get domain name by IP address from dns stats table
get
timeseriesStats
Get appliance time series stats data filter by certain query parameters.
get
Get appliance time series stats data filter by certain query parameters and certain appliance IDs.
post
Stats of appliance Process State.
get
Get availability tunnel timeseries data.
get
Get availability interface timeseries data.
get
Get availability appliance timeseries data.
get
Get new application time series stats data filter by certain query parameters.
get
Get new application time series stats data filter by certain query parameters and certain appliance IDs.
post
Get new user time series stats data filter by certain query parameters and certain appliance IDs.
post
Get boost time series stats data of a single appliance filter by certain query parameters.
get
Get tunnel time series drc stats data of a single appliance filter by certain query parameters.
get
Get tunnel time series drc stats data filter by certain query parameters and certain appliance IDs.
post
Get dscp time series stats data filter by certain query parameters.
get
Get dscp time series stats data filter by certain query parameters and certain appliance IDs.
post
Get flow time series stats data filter by certain query parameters.
get
Get flow time series stats data filter by certain query parameters and certain appliance IDs.
post
Get flow time series stats data filter by certain query parameters.
get
Get interface time series stats data of a single appliance filter by certain query parameters.
get
Get interface overlay transport time series stats data of a single appliance filter by certain query parameters.
get
Get internalDrops time series stats data of a single appliance filter by certain query parameters.
get
Get time series jitter stats data filter by query parameters.
get
Get memory statistics data of the appliance IDs for the specified duration of time.
post
Get memory statistics data in specific time range
get
Get Mean Opinion Score time series stats data of a single appliance filter by certain query parameters.
get
Get security policy time series stats data of a single appliance filter by certain query parameters.
get
Get Shaper time series stats data filter by certain query parameters and certain appliance IDs.
get
Get Shaper time series stats data filter by certain query parameters and certain appliance IDs.
post
Get traffic class time series stats data of a single appliance filter by certain query parameters.
get
Get traffic class time series stats data filter by certain query parameters and certain appliance IDs.
post
Get tunnel time series stats data of a single appliance filter by certain query parameters.
get
Returns Traffic Behavioral timeseries stats
get
statsCollection
Assign stats collector to list of appliance
post
Get stats collector assignments for provided appliance ids(NePk)
post
Get stats collector backup configuration
get
Add or update stats collector backup configuration
post
Test the stats collector backup remote server whether it can connect.
post
Get whether stats collector backup uses gms backup configuration
get
Set whether stats collector backup should use gms backup configuration
post
Get all stats collector configurations
get
Add new stats collector
post
Update stats collector
put
Delete stats collector
del
Discontinue legacy stats collection
post
Enable new stats collection
post
Get migration status
get
Get health status of all stats collectors
get
Get appliances in network which are not compitable with new stats collection and needs to be upgraded
get
subnets
Configure an appliance's subnets.
post
Get a discovered appliance's subnets information.
get
Configure appliance's subnet sharing options
post
Get an appliance's subnets information.
get
appSystemDeployInfo
Get Appliance System Deployment Information
get
appSystemStateInfo
Get Appliance System State Information
get
tca
Get system threshold crossing alerts
get
tcpdump
POST operation to start the packet capture process.
post
GET operation to show current packet capture process status.
get
Get the primary keys of all running tcp dumps.
get
template
Returns the association map of template groups for appliances.
get
Associates the templates with a specific appliance. The array posted is the complete association for that appliance.
post
Returns the list of template groups applied to the appliance
get
Returns history of applied templates by nePk
get
Creates a new template group
post
Deletes a template group
del
Returns all template configurations or for the specified template group
get
Creates a new template group from an existing one or updates the configuration of the requested template group
post
Deletes existing template group
post
Returns the order that template groups will be applied in
get
Post the order that template groups should be applied in, groups not listed are not in a deterministic order
post
Returns the selected templates in the template group
get
Selects the provided templates in the request body
post
thirdPartyLicenses
Gets all third party licenses information
get
thirdPartyServices
Get Aruba Central site and appliances mapping
get
Manually assign appliance to the aruba central site
post
Delete Subscription
del
Returns Aruba Central subscription
get
Add/Update Subscription
post
Returns list of AWS VPN Connections created for appliances associated to Transit Gateway in Global Network.
get
Gets all AWS VPN Connection BGP Peer Status of appliance
get
Returns AWS Transit Gateway Network Manager connectivity status
get
Returns recommended tunnel setting for AWS Transit Gateway Network Manager
get
Returns map of Global Network ID to list of AWS Transit Gateway Objects available in Orchestrator cache
get
Returns Appliance to AWS TransitGateway Association
get
Returns map of Global Network ID to Global Network Name
get
Get primary and backup interface label order configured using which Vpn Connections will be created in AWS Transit Gateway Network Manager.
get
Set primary and backup interface label order configured using which Vpn Connections will be created in AWS Transit Gateway Network Manager.
post
Returns AWS Transit Gateway Network Manager Orchestration Pause state
get
Set AWS Transit Gateway Network Manager pause orchestration configuration.
post
Return polling interval in seconds to get the latest Global Network and associated Transit Gateways from AWS Portal
get
Delete AWS Transit Gateway Network Manager Subscription
del
Returns AWS Transit Gateway Network Manager subscription
get
Add/Update AWS Transit Gateway Network Manager Subscription
post
Returns Appliance to AWS TransitGateway Association
get
Posts Appliance to AWS TransitGateway association
post
Get tunnel settings configured to build AWS VPN Connection tunnels.
get
Set tunnel settings configured to build AWS VPN Connection tunnels.
post
Get VTI Subnet and Mask for the AWS Subnet Global Pool
get
Update VTI Subnet and Mask for the AWS Subnet Global Pool
post
Get all VTI Subnets from AWS Subnet Global Pool
get
Returns list of Azure VPN Sites created for appliances associated to Virtual Wan.
get
Gets Azure VWAN VPN Connection BGP Peer Status of appliance
get
Returns Azure VWAN connectivity status
get
Returns recommended tunnel setting for Azure
get
Get primary interface label order configured using which Vpn Sites will be created in Azure.
get
Set primary interface label order configured using which Vpn Sites will be created in Azure.
post
Returns Azure Orchestration Pause state
get
Posts Azure Orchestration Pause state
post
Delete Azure Subscription
del
Returns Azure subscription
get
Add/Update Azure Subscription
post
Get tunnel settings configured to build Azure Virtual WAN pass through tunnels.
get
Set tunnel settings configured to build Azure pass through tunnels.
post
Returns Appliance to Virtual WAN association for Azure
get
Posts Appliance to Virtual WAN association for Azure
post
Delete check point subscription
del
Get check point subscription
get
Set check point subscription
post
Get check point connectivity status
get
Get interfaces configured for which sites will be created on check point.
get
Set interfaces configured for which sites will be created on check point.
post
Get default tunnel settings configured to build Check Point CloudGuard Connect pass through tunnels.
get
Get tunnel settings configured to build Check Point CloudGuard Connect pass through tunnels.
get
Set tunnel settings configured to build Check Point CloudGuard Connect pass through tunnels.
post
Get check point pause orchestration configuration.
get
Set check point pause orchestration configuration.
post
Return time gap in seconds between two times of downloading locations and sub-locations from Check Point CloudGuard Connect portal
get
Get check point sites configuration.
post
Delete existed configured LAN subnets of the appliance.
del
Get configured LAN subnets of the appliance.
get
Add configured LAN subnets of the appliance.
post
Get configured LAN subnets of the appliance.
get
Associate a appliance to Check Point Harmony.
post
Get configured ipsla setting with Check Point Harmony
get
Saves ipsla setting with Check Point Harmony
post
Get configured LAN subnets of the appliance.
get
Associate a appliance to Check Point Harmony.
post
Delete ClearPass Policy Manager account configuration.
del
Get ClearPass Policy Manager account details using ID
get
Update ClearPass Policy Manager account configuration.
put
Add new ClearPass Policy Manager account.
post
Pause individual ClearPass Policy Manager orchestration.
put
Get all ClearPass Policy Manager configuration
get
Get ClearPass Policy Manager account connectivity status
get
Posts ClearPass Policy Manager login event
post
Posts ClearPass Policy Manager logout event
post
Filter ClearPass Policy Manager events
get
Get username and role list for given IP and time range
get
Get ClearPass Policy Manager pause orchestration.
get
Set ClearPass Policy Manager pause orchestration.
post
Reset ClearPass Policy Manager service endpoint
put
Get ClearPass Policy Manager service endpoint status
get
Returns Service Orchestration BIO Breakout state
get
Set Service Orchestration BIO Breakout state.
post
Enable/Disable IPSLA settings for Service Provider
get
Enable/Disable IPSLA Settings for Service Provider.
post
Returns IPSLA settings for Service Provider
get
Posts IPSLA Settings for Service Provider.
post
Returns recommend tunnel setting for Service Orchestration
get
Get primary and backup interface labels configured for a Service Provider.
get
Set primary and/or backup interfaces for a Service Provider.
post
Returns Service Orchestration Pause state
get
Set Service Orchestration Pause state.
post
Returns appliance to remote endpoint association.
get
Updates appliance to remote endpoint association.
post
Add list of Remote Endpoints to existing remote endpoints of the Service Provider.
post
Deletes Remote Endpoint entries
del
Get remote endpoints for service id.
get
Set Remote Endpoints list for the service.
post
Returns list of Service Provider Connections created for appliances associated to Remote Endpoints.
get
Gets all ServiceProvider Tunnels with IP SLA's status of the appliance. The response contains <nePk_labelId>, <connectionStatus> map.
get
Get all Service Providers configured for Third Party Orchestration
get
Gets ServiceProvider Tunnel IKE identifier - local, primary remote, backup remote identifiers for every network interface.
get
Get all Service Providers configured for Third Party Orchestration
get
Add new Service Provider
post
Get tunnel settings configured for a Service Provider.
get
Set tunnel settings for a Service Provider.
post
Returns Appliance to Zscaler association
get
Posts Appliance to Zscaler association
post
Returns Zscaler configuration, including tunnel setting, selected interface label order
get
Update Returns Zscaler configuration, including tunnel setting, selected interface label order
post
Returns Zscaler connectivity status
get
Returns Appliance to Zscaler countries
get
Posts Standard Alpha2 country to Zscaler country. Use | as separator to add more mappings.
post
Returns list of countries with ISO 2 code to Zscaler country.
get
Returns Appliance to Zscaler default timezones
get
Returns recommend tunnel setting for Zscaler
get
Returns IPSLA settings for Zscaler
get
Posts IPSLA Settings for Zscaler.
post
Enable/Disable IPSLA settings for Zscaler
get
Enable/Disable IPSLA Settings for Zscaler.
post
Returns calculated Zscaler locations and sub-locations entries and their gateway options and bandwidth control based on current gateway options configuration
get
Returns Tunnel Setting for every Interface label.
get
Posts InterfaceTunnelSetting for every interface label.
post
Returns Zscaler Location and Sub-Location gateway options and bandwidth control configuration
get
Update Zscaler Location and Sub-Location gateway options and bandwidth control configuration
post
Returns whether to use current location configuration to controll locations or sub-locations gateway options or bandwidth control
get
Update whether to use current location configuration to controll locations or sub-locations gateway options or bandwidth control
post
Get all VPN, Location, discovered and configured ZEN override data for one or more appliances
post
Gets all Zscaler Tunnels with IP SLA's status of the appliance. The response contains <nePk_labelId>, <connectionStatus> map.
get
Returns Pause Zscaler Orchestration configuration
get
update pause Zscaler Orchestration configuration
post
Return time gap in seconds between two times of downloading locations and sub-locations from Zscaler Internet Access portal
get
Returns Zscaler Task Manager status for all the appliances. This API is used only for debugging if any appliance is not getting Zscaler orchestrated.
get
Delete user configured ZEN override data
del
Add/Update user configured ZEN override data
post
Returns all user configured ZEN Override data
get
Delete Subscription
del
Returns Zscaler subscription
get
Add/Update Subscription
post
Returns Standard Timezone to Zscaler timezones
get
Posts Standard Timezone to Zscaler time zone. Use | as separator to add more mappings.
post
Gets Zscaler VPN location of the appliance.
get
Delete Subscription
del
Returns Netskope subscription
get
Add/Update Subscription
post
Returns Netskope connectivity status
get
Returns Netskope configuration, including tunnel setting, selected interface label order
get
Update Returns Netskope configuration, including tunnel setting, selected interface label order
post
Returns Tunnel Setting for every Interface label.
get
Posts InterfaceTunnelSetting for every interface label.
post
Returns recommended tunnel setting for Netskope.
get
Returns IPSLA settings for Netskope
get
Posts IPSLA Settings for Netskope.
post
Enable/Disable IPSLA settings for Netskope
get
Enable/Disable IPSLA Settings for Netskope.
post
Returns Appliance to Netskope association
get
Posts Appliance to Netskope association
post
Gets all Netskope Tunnels with IP SLA's status of the appliance. The response contains <nePk_labelId>, <connectionStatus> map.
get
Get all Location data for one or more appliances
post
Returns Pause Netskope Orchestration configuration
get
update pause Netskope Orchestration configuration
post
Return time gap in seconds between two times of downloading locations from Netskope Internet Access portal
get
Returns Netskope Task Manager status for all the appliances. This API is used only for debugging if any appliance is not getting Netskope orchestrated.
get
bondedTunnelsConfiguration
Get the current list of tunnels state
post
Get bonded tunnels for all appliances
get
Get bonded tunnels a physical tunnel belongs to
get
tunnelsConfiguration
Get the current list of tunnels state
post
Initiate a traceroute on a tunnel
post
Get traceroute state for a tunnel
post
Get tunnel id's of physical tunnels of an appliance with particular state
get
Search total tunnel count, all appliances
get
Get all tunnels between appliances
post
Search physical tunnels, all appliances
get
Returns individual tunnel count by overlay on selected appliances
post
thirdPartyTunnelsConfiguration
Get the current list of tunnels state
post
Search pass through tunnels
get
uiUsageStats
Add usage count for one UI feature
post
upgradeAppliances
Upgrade appliances with option
post
Check ECOS version compatibility for appliance upgrades through Portal
post
userAccount
Gets all user details and sessions of appliance
get
user
Returns user details. Gets user by username if provided
get
Creates a new user or updates it. 'Status: Active/Inactive. Role: Admin Manager/Network Monitor'
post
Deletes the specified user
del
Forgot password
post
Returns a barcode to scan with an authentication application to set up app based two factor authentication for your account
get
Resets user password
post
Changes user password
post
loopback
Get loopback interface configuration on the appliance
get
vti
Get VTI interface configuration on the appliance
get
vrf
Return Routing Segmentation enable defined in Orchestrator
get
Update Routing Segmentation enable
post
Delete specific segment DNAT policies
del
(1) Get all DNAT Policies configured on the orchestrator (2) Get DNAT Policies of required source segment
get
Edit DNAT Policies of required source segment
post
Get all Security Policies configured on the orchestrator
get
Edit orchestration Security policies
post
Gets all security maps
get
Delete required segment
del
Returns required or all Segment defined in Orchestrator
get
Modify existing Segment
put
Add new Segment
post
Returns all disabled Inter-Segment SNAT rules defined in Orchestrator
get
Add/Edit Inter-Segment SNAT rules
post
vrrp
Get a list of VRRP instances configured on the appliance
get
applianceUpgrade
Delete ECOS image
del
Get ECOS images
get
wccp
Get WCCP service groups settings for the appliance.
get
Get WCCP system settings for the appliance
get
Get WCCP state
get
zones
Returns all Zones defined in Orchestrator
get
Add/Edit Zones
post
Returns End to End Zone Based Firewall Config in Orchestrator
get
Add/Edit End to End Zone Based Firewall Config
post
Returns Next Id that should be assigned to a new Zone
get
Update Next Id
post
Returns vrfSegmentZoneMap details
get
Returns vrf firewall zones map
get
availabilityTimeSettings
Get availability time settings for provided appliance ids(NePk)
post
Post availability time settings for appliances
post
applianceCPUstats
Retrieve CPU history data and upload to Orchestrator database
post
Cancel CUP stats fetch request
get
CUP stats fetch request status
get
Max Timestamp of CPU stats that are available on Orchestrator
get
Appliance CPU timeseries stats
get
ScheduledPDFreports
Returns list of schedule reports
get
idps
Get IDPS configuration
get
Set IDPS configuration
put
Get IDPS signatures
get
Get IDPS signatures diff
get
Get IDPS signatures rules
get
Get IDPS signatures profiles
get
Set IDPS signatures profiles
post
Get IDPS profile state
get
Set IDPS profile state
put
Get IDPS state
get
Set IDPS state
put
Update IDPS signature from portal
get
Orchestrator High Availablability
Get HA mode orchestrator server info
get
Get HA notification configuration
get
Update HA notification configuration
put
Get all orchestrator instances
get
Update HA instance comment
put
Decommission orchestrator instance
del
Promote current instance to be the new primary orchestrator
put
Check primary instance HTTP status
get
Update HA cluster reachability config
post
Get HA cluster reachability config
get
vxlan
Returns common VXLAN settings
get
Returns vrf and vni map
get
StatsDebug
Get all StatisticsP99 entries
get
Silver Peak Unity ECOS REST APIs
login
Create a new authenticated HTTP session
post
Determine if the session denoted by the cookie 'vxoaSessionID' in the HTTP header is still authenticated
get
Logout of session denoted by the cookie 'vxoaSessionID' in the HTTP header
post
ipObjects
Retrieves the address groups hash.
get
Trigger address groups file processing.
post
Retrieves the service groups hash.
get
Trigger service groups file processing.
post
scalars
Get the VXOA scalars.
get
statistics
Get aggregate appliance statistics
get
Get aggregate application statistics
get
Get aggregate Traffic Class statistics
get
Get cumulative Linux ifconfig statistics for each interface on the appliance
get
Get the oldest minute and latest minute for which per minute statistics are available
get
Get specific minute statistics file
get
Get real time per second statistics
post
flows
Returns the so far accumulated bandwidth stats about the flow
get
Returns flow details
get
Returns more detailed info about the flow
get
Returns active, inactive, or both types of flows on the appliance based on the query parameters supplied
get
Reclassifies the flow(s)
post
Resets the flow(s)
post
alarm
Returns active alarms
get
Acknowledges alarms whose sequence IDs are provided
post
Clears alarms whose sequence IDs are provided
post
Delete closed alarms whose sequence IDs are provided
post
Get Orchestrator alarm descriptions
get
Notes captured for alarms whose sequence IDs are provided
post
cnprocess
state of process
get
managementInterface
Get the management interface address.
get
Set management interface address
post
license
Get appliance license key and its validity
get
Set license key
post
Delete license token on appliance.
del
Validate a license key
post
deployment
Get the current deployment configuration
get
Modify the deployment settings
post
validate the deployment settings
post
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
Get a list of VRRP instances configured on this appliance
get
Add/Modify VRRP instances on this appliance
post
Add/Modify VRRP instances on this appliance from Orchestrator
post
wccp
Get WCCP service groups settings.
get
Modify the current WCCP service groups settings.
post
Get WCCP service group {groupId} settings.
get
Modify WCCP service group {groupId} settings.
post
Get WCCP system settings.
get
Modify the current WCCP system settings.
post
Get WCCP state.
get
localSubnets
Api to find the preferred routes based on the posted entries
post
Gets routing peers information.
get
Gets all configured, learned subnets from remote Silverpeak appliances and automatically learned local subnets.
get
Gets all segments configured, learned subnets from remote Silverpeak appliances and automatically learned local subnets
get
Gets specified segment configured, learned subnets from remote Silverpeak appliances and automatically learned local subnets.
get
Get configured local subnets only.
get
Add or delete configured local subnets
post
Adds routes to existing routes
post
Deletes routes specified in the Array.
post
Get configured subnets of a specified segment.
get
Add or delete configured subnets of a specified segment.
post
tunnel
Add multiple tunnels in one shot.
post
Set all tunnels on the system to the settings provided.
post
Delete multiple tunnels in one shot.
post
Get multiple tunnels in one shot.
post
Get multiple tunnels state in one shot.
post
Get a list of interface IP addresses which can be used as passthrough tunnel source IP addresses on this appliance.
get
Find tunnels with matching aliases
get
Get the current list of physical tunnels
get
Get a list of interface IP addresses which can be used as tunnel source IP addresses on this appliance.
get
Get the current list of tunnels and their configuration fields only.
get
Add/delete and modify tunnels.
post
Delete a tunnel by id (name)
del
Get a specific tunnel by id (name)
get
Modify or add a single tunnel by id (name)
post
Start MTU discovery on the list of input tunnels.
post
Get the current list of tunnels and their configuration as well as some state information like uptime and operational state
get
Set the ipsec preshared key for multiple tunnels.
post
bondedTunnel
Find bonded tunnels with matching aliases
get
Get the current list of bonded tunnels
get
Get the current list of tunnels and their configuration fields only.
get
Add and modify tunnels.
post
Delete a tunnel by id (name)
del
Get a specific tunnel by id (name)
get
Delete multiple bonded tunnels
post
Get multiple bonded tunnels
post
Get multiple bonded tunnels state
post
Get the current list of tunnels and their configuration as well as some state information like uptime and operational state
get
Get a specific bounded tunnel live view state by id (name)
get
thirdPartyTunnel
Find pass through tunnels with matching aliases
get
Get the current list of third party tunnels
get
Get the current list of tunnels and their configuration fields only.
get
Add and modify tunnels.
post
Delete a tunnel by id (name)
del
Get a specific tunnel by id (name)
get
Delete multiple third party tunnels
post
Get multiple third party tunnels
post
Get multiple third party tunnels state
post
Get the current list of tunnels and their configuration as well as some state information like uptime and operational state
get
routePolicy
Get dependency information for route map
get
Get current route policies
get
Modify current route policies
post
Delete multiple rules from multiple maps
post
Delete route map {mapName}.
del
Get the setting of route map {mapName}.
get
optimizationPolicy
Get current optimization policies
get
Modify current optimization policies
post
Get default rules for optimization map
get
Delete multiple rules from multiple maps
post
Delete optimization map {mapName}.
del
Get the setting of optimization map {mapName}.
get
qosPolicy
Get current qos policies
get
Modify current qos policies
post
Get default rules for qos map
get
Delete multiple rules from multiple maps
post
Delete DSCP overrides on the appliance
del
Get currently defined DSCP overrides
get
Update/Create DSCP overrides on the appliance
post
Delete qos map {mapName}.
del
Get the setting of qos map {mapName}.
get
shaper
Get the shaper configuration
get
Modify shaper configuration
post
Delete shaper configuration for an interface
del
Get the shaper configuration for a particular WAN interface
get
Modify shaper configuration for an interface
post
inboundShapers
Get the shaper configuration
get
Modify shaper configuration
post
Delete shaper configuration for an interface
del
Get the shaper configuration for a particular WAN interface
get
Modify shaper configuration for an interface
post
trafficClass
Get the traffic names.
get
Modify the traffic names.
post
natPolicy
Get current NAT policies
get
Modify current NAT policies
post
Delete multiple rules from multiple maps
post
Delete NAT map {mapName}.
del
Get the setting of NAT map {mapName}.
get
peers
Get the peers of current appliance.
get
Get the silver peak peers of current appliance.
get
acls
Get the current Access lists settings.
get
Modify the current Access lists settings.
post
Delete Access list {aclName}.
del
Get the setting of Access list {aclName}.
get
Get dependency information for ACL
get
userDefinedApplications
Get all dependencies of a specific user application
get
Get all dependencies of a specific user group
get
delete all user defined applications
del
Get all the user defined applications
get
add/updates the user defined app(s)
post
Delete user application by priority
del
Get user defined application matching a priority
get
applicationGroups
Gets all user groups
get
add/updates the details of group(s)
post
Delete group by name
del
Get a specific group by name
get
log
Modify both logging configurations and remote receivers in one request
post
Get logging configurations including minimum log level, maximum log file size and number of log files.
get
Modify logging configurations including minimum log level, maximum log file size and number of log files.
post
Get remote logging receivers.
get
Modify remote logging receivers
post
flowRedirection
Get the flow redirection configuration.
get
Enable/disable flow redirection. Add flow redirection peers.
post
Get the flow redirection state
get
systemInfo
Get system information on the appliance.
get
proxyInfo
Get Proxy information of the appliance.
get
system
Get appliance's system level configuration data.
get
Set appliance's system level configuration.
post
Get a specific system configuration attribute
get
saasOptimization
Get SaaS Optimization configuration information
get
Modify SaaS Optimzation configuration information
post
Get SaaS Optimization licensing status
get
Get SaaS Optimization monitoring information
get
tcpdump
GET operation to download an archive of packet capture files
get
GET operation to show number of finished processes and total number of processes
get
GET operation to fetch list of interface for tcpdump capturing.
get
POST operation to start an packet capture process.
post
GET operation to show current packet capture process status.
get
POST operation to stop current packet capture process.
post
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
GET operation to retrieve interface IP address for a given path
get
[Client Side] POST operation to start link integrity test
post
[Server Side] POST operation to start link integrity test
post
GET operation to retrieve link integrity test status
get
POST operation to stop current link integrity test
post
reboot
Checks if appliance requires a reboot
get
Get the process info of node.
get
Get processes that require restart
get
Request a process to be restarted
post
Get the Last Reboot Information of the Appliance.
get
Get the reboot state.
get
Request for reboot.
post
spPortal
Get Silver Peak Portal registration and configuration information
get
Configure Silver Peak Portal
post
Get connectivity status of Silver Peak Portal
get
Configure EC license request
post
Get portal token and licensing state
get
Get Silver Peak Portal registration information
get
Register appliance with Silver Peak Portal
post
internetDatabase
Get geolocation information for a multiple ip's from portal
post
Get geolocation information for a single ip from portal
get
Get ip to service id mapping
get
Get service id to service details mapping
get
Get count of internet services on this appliance
get
Get a list of unique countries in the internet services database
get
Get a list of unique saas applications in the internet services database
get
Get a list of unique saas applications or organizations in the internet services database
get
netFlow
Get the netFlow settings on the appliance.
get
Apply the netFlow settings on the appliance.
post
Get the netFlow stats
get
saveChanges
Save the changes in memory to a file in the appliance.
post
snmp
Get the current SNMP server settings configured for your appliance.
get
Set the SNMP server settings for your appliance.
post
Get interface indices info
get
builtInApps
Returns built-in applications
get
Returns built-in applications along with their ports
get
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 nodejs
post
networkMemory
Erase network memory
post
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 disk
post
bypass
Returns info about current bypass mode settings
get
Toggles bypass mode - only effective on NX appliances
post
authentication
Get the current authentication order and authorization information for your appliance.
get
Modify authentication order and authorization information for your appliance.
post
Get the current RADIUS server settings configured for your appliance.
get
Modify RADIUS server settings for your appliance.
post
Get the current TACACS+ server settings configured for your appliance.
get
Modify TACACS server settings for your appliance.
post
gms
Get all the Orchestrators managing this appliance
get
Update Orchestrator that will manage this appliance
post
Tests various protocol connectivity status between the appliance and Orchestrator that is managing this appliance
get
Unregister an Orchestrator from managing this appliance
del
debugFiles
Get the debug files on the appliance.
get
Cancel zipping the debug files on the appliance.
post
Generate the Sys Dump file on the appliance.
get
Get the status of generating Sys Dump file on the appliance.
get
Delete the debug file on the appliance.
post
Download the debug file on the appliance.
get
Zip the debug files on the appliance.
post
Get the status of zipping the debug file on the appliance.
get
diskUsage
Get the disk usage of the appliance.
get
softwareUpgrade
Install image
post
Cancel installing image
post
Get the current software versions of two partitions
get
Set the next root partition
post
Upgrade software and reboot or not
post
Get the status of software upgrade progress
get
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
Get all tca data.
get
Modify all tca data
post
Get system tca by tca id
get
Modify the tca info by id
post
Get all tunnel tca data.
get
Get tca data for a specified tunnel name
get
Modify tunnel tca data for a specified tunnel name
post
logViewer
Get date range of the specified type log file
get
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
Run the ping or traceroute commands on the appliance.
post
Stop the running the ping or traceroute commands on the appliance.
del
Get the result of running the ping or traceroute commands on the appliance.
get
sslCerts
Post the certificates details to appliance
post
Get all SSL certificates on the appliance
get
Post the SSL certificates to the appliance
post
Push the SSL certificates from Orchestrator to the appliance
post
sslSubstituteCert
Get all SSL Substitute certificates on the appliance.
get
Apply the SSL Substitute certificate to the appliance.
post
Send request to the administrator for new Certificate
post
Create the SSL Substitute certificate file.
post
Export the SSL Substitute certificate file.
post
Validate the SSL Substitute certificate
post
Push the SSL Substitute certificates from Orchestrator to the appliance.
post
sslCACerts
Get a list of well known CA Certificates downloaded from Portal
get
Validate the SSL CA certificate file.
post
Get all CA SSL certificates on the appliance
get
Apply the CA SSL certificates to the appliance
post
Push the SSL certificates from Orchestrator to the appliance
post
configdb
Get the backup/restore files information of this appliance.
get
Backup current appliance configuration in a new file.
post
Download some backup file to the computer from the appliance.
get
Change the configuration of the appliance to the one stored in the specified backup file.
post
Copy some backup file from /tmp/ to /config/db/ on the appliance.
post
Delete some existed backup file from this appliance.
del
users
Gets all users details
get
add/updates used account details
post
Delete certain sessions
post
eventManagement
Appliance notifies Orchestrator when a configuration change is made. If for some reason the change events didn't reach Orchestrator, Orchestrator can call this api to get any configuration events that it missed
get
get the current event notification state
get
turn on/off event notification to Orchestrator
post
The last configuration and state events sent by appliance to Orchestrator
get
List of resources whose changes will be notified to Orchestrator
get
Appliance notifies Orchestrator when a state change happens on appliance. If for some reason the change events didn't reach Orchestrator, Orchestrator can call this api to get any state events that it missed
get
cli
Run single cli command on the appliance
post
Run multiple cli commands on the appliance
post
sysLimits
Get appliance's system limits configuration data.
get
Set appliance's system limits configuration.
post
Get a specific system limits attribute
get
interfaces
Get interface related information.
get
Get a specific interfaces attribute
get
memory
Get memory info on the appliance.
get
fileOps
Upload, download or delete a file
post
thirdPartyLicenses
Gets all third party licenses information
get
interfaceLabels
Returns all the labels for both types of interfaces, wan and lan
get
Saves both Wan and Lan labels
post
Returns all the labels for the given type
get
Delete the {labelId} in {type}
del
overlays
Get the overlays stored in the appliance
get
Add and update multiple overlays for the appliance
post
Deletes the overlay from the appliance.
del
Returns one overlay that has the id of the passed overlayId parameter
get
/overlays3/config/{overlayId}
post
Deletes multiple overlays
post
dhcpd
Get dhcpd configuration.
get
Get dhcpd leases information.
get
Get dhcpd leases report of failover state
get
bgp
Get BGP neighbors configuration data.
get
add/updates BGP neighbors configuration data.
post
add/updates BGP neighbors configuration data.
post
Deletes neighbors specified in the Array.
post
Delete specific neighbor list.
del
Get specific neighbor configuration data.
get
add/updates specific neighbor configuration data.
post
Get appliance's BGP system level configuration data.
get
Set appliance's BGP system level configuration data.
post
Get appliance BGP Global level configuration data.
get
Set appliance's BGP global level configuration data.
post
Delete all segment neighbors.
del
Get neighbors of all segment.
get
add/updates all segments BGP neighbors data.
post
Get specific all segment BGP configuration.
get
Post all segments BGP configuration
post
Delete all/specific segment neighbors.
del
Get neighbors of a specific segment.
get
add/updates all segment BGP neighbors configuration data.
post
Delete single segment neighbor.
del
Get a single neighbor with specific segment.
get
POST a single neighbor with specific segment.
post
Get specific segment BGP configuration.
get
Set specific segment BGP configuration
post
Gets the state of the BGP and its neighbors configuration data.
get
Delete specific/all segment BGP state
get
httpsCertsUpload
Get the certificate info
get
Set the certificate info
post
Validate the certificate file and key
post
topSites
Get list of top internet sites
get
tcpUdpPorts
Get TCP/UDP ports data
get
ipProtocolNumbers
Get list of IP Protocol Numbers
get
backtrace
Get the crash info of this appliance.
get
peerPriorityList
Delete some the peer host priorities of current appliance.
del
Get the peer priority list of current appliance.
get
Add or modify the peer priority list of current appliance.
post
peerPriorityList2
Delete some the peer host priorities of current appliance.
del
Get the peer priority list of current appliance.
get
Add or modify the peer priority list of current appliance.
post
statsConfig
Get stats config of this appliance.
get
Set stats config of this appliance.
post
internalSubnets
Get the internal subnets
get
Save internal subnets
post
pppoe
Get config of PPPoE.
get
Modify the config of PPPoE
post
Get PPPoE interfaces state.
get
Delete PPPoE {pppoeName}.
del
ipSla
Get current IP SLA Manager Rules
get
Post IP SLA rules.
post
Delete IP SLA Manager
del
Get IP SLA Manager Rule info
get
Post IP SLA rule.
post
Gets IP SLA Managers state details
get
applicationDefinition
Search application based on pattern and limit
post
Get application groups
get
Get the hash code for application groups
get
Get the hash code for application names
get
Get the current application definition for Compound rules
get
Get the hash code for application definition for Compound rules
get
Get the current application definition for Domain Name
get
Get the hash code for application definition for Domain Name
get
Get application definition data for IP Intelligence from portal
get
Get the timestamp for application definition for IP Intelligence
get
Get the current application definition for Meter Flow
get
Get the hash code for application definition for Meter Flow
get
Get the current application definition for IP Protocol, TCP Port, UDP Port
get
Get the hash code for application definition for IP Protocol, TCP Port, UDP Port
get
Get the hash code for application definition for SaaS
get
urlDownload
GET /urlDownload to get the status of all the downloads performed within last 24 hours.
get
Check reachability of a URL and/or download contents
post
Get urlDownload test result
get
dnsCache
Gets DNS Cache configurations
get
POSTs DNS Cache configurations
post
ipsecUdp
Get the IPSEC UDP local and peer ports
get
Configure IPSEC UDP Ports
post
adminDistance
Get the admin distance config of current appliance.
get
Modify the admin distance config of current appliance.
post
portForwarding
Get port forwarding rules on this VXOA.
get
Set gms marked port forwarding rules on this VXOA by gms.
post
Set port forwarding rules on this VXOA by user.
post
tunGlobalConfig
Get the current global configuration for tunnel
get
Update the current global configuration for tunnel
post
xcvr
Get transceiver status for a 10Gig interface
get
ospf
Get all segments OSPF Interfaces configurations.
get
Set all segments OSPF interfaces configuration.
post
Get all segments system level OSPF configuration.
get
Set all segments specific system level OSPF configuration.
post
Get appliance's OSPF areas configuration data.
get
Set appliance's OSPF areas configuration data.
post
Get OSPF interfaces configuration data.
get
add/updates OSPF interfaces configuration data.
post
Get appliance's OSPF system level configuration data.
get
Set appliance's OSPF system level configuration data.
post
Get segment specific OSPF Interfaces.
get
Set Segment specific OSPF interfaces.
post
Get Segment specific system level OSPF configuration.
get
Set Segment specific system level OSPF configuration.
post
Gets all segments OSPF interfaces state.
get
Gets all segments OSPF neighbors state.
get
Gets all segments OSPF state.
get
Gets the state of the OSPF interfaces.
get
Gets the state of the OSPF neighbors.
get
Gets the state of the OSPF.
get
Gets OSPF interfaces state of a specific segment.
get
Gets OSPF neighbors state of a specific segment.
get
Gets the OSPF state of a specific segment.
get
zones
Returns all zones
get
Add/Edit Zones
post
Returns End to End Zone Based Firewall Config in Orchestrator
get
Add/Edit End to End Zone Based Firewall Config
post
Delete Zone by id
del
Return Zone by id
get
Add/Edit Zone by id
post
securityMaps
Get Security Policies
get
Add/Edit Security Policies
post
Get Security Policies by map name
get
Delete Security Policy by zone map
del
Get Security Policies by map name & zone map
get
Delete rule by priority
del
Get Security Policies Settings
get
Edit Security Policies Settings
post
Get Security Policies Settings by map name
get
builtInPolicies
Get current built-in policies
get
runningConfig
Start a job to generate running config
post
Fet running config data
get
Get status of the backend handler job
get
nslookup
Delete DNS lookup cache
del
Get DNS lookup cache
get
Get IP for a given FQDN
get
Get IP for a given FQDN resolved using an appliance interface
get
regions
Get all regions
get
Set regions
post
Get region configuration
get
Set region configuration
post
multicast
Get multicast configuration, including rendezvous point and interfaces configuration
get
Set multicast configuration
post
Get multicast enable / disable state
get
Enable / disable multicast
post
Get multicast interfaces state
get
Get multicast neighbors state
get
Get multicast routes state
get
nat
Get NAT Maps
get
Add/Edit Branch NAT rules
post
Delete NAT Map by name
del
Get NAT Map by name
get
Delete NAT Map Rule
del
Get NAT Map Rule
get
Add/Edit NAT Map Rule
post
Returns all NAT Pools
get
Update NAT Pools
post
Delete NAT Pool by id
del
Return NAT Pool by id
get
Update NAT Pool by id
post
loopback
Get config of loopback interfaces.
get
Modify the config of loopback interfaces
post
Delete loopback interface {loopbackName}.
del
Get loopback interface {loopbackName}.
get
Update or create loopback interface {loopbackName}.
post
vti
Get config of vti interfaces.
get
Modify the config of vti interfaces
post
Delete vti interface {vtiName}.
del
Get vti interface {vtiName}.
get
Update or create vti interface {vtiName}.
post
Add or modify multiple config of vti interfaces
post
Delete multiple config of vti interfaces
post
dnsProxy
Get the DNS proxy config
get
Modify the DNS proxy config
post
mgmtServices
Get the management services data of current appliance.
get
Modify the management services config of current appliance.
post
redistRouteMaps
Get current redistribution Maps
get
Post list of route redistribution maps.
post
customApplianceTags
Gets all users defined entries
get
add/updates users defined entries
post
security
Get advanced security settings
get
Set advanced security settings
post
Get protection profiles
get
Set protection profiles
post
Get protection profile for zoneId
get
Delete protection profile for zoneId
del
Get dos thresholds status
get
Get dos thresholds status for zoneId
get
ikeless
Active Ikeless seed
post
Get the seed status
get
Update Ikeless seed
post
vrfZonesMap
Returns vrf firewall zones map
get
Add/Edit vrf firewall zones map
post
vrfs
Return Routing Segmentation enable
get
Update Routing Segmentation enable
post
Get all D-NAT Policies
get
Edit D-NAT Policies
post
Delete multiple rules from multiple maps
post
Delete specific segment D-NAT policies
del
Get D-NAT Policies of required source segment
get
Edit D-NAT Policies of required source segment
post
Delete D-NAT Policies of required rule
del
Get D-NAT Policies of required rule
get
Edit D-NAT Policies of required rule
post
Return all Segments
get
Add new Segment
post
Delete required segment
del
Return required Segment
get
Modify existing Segment
post
Returns Inter-Segment S-NAT rules
get
Add/Edit Inter-Segment S-NAT rules
post
idsips
Update config of idsips engine
post
Gets evennts of idsips engine
get
Update signature of idsips engine
post
Gets state of idsips engine
get
Update state of idsips engine
post
Gets stats of idsips engine
get
customCaCerts
Get list of all custom CA certificates
get
Add new or update existing custom CA certificate
post
Delete custom CA certificate
del
Checks whether appliances can connect to Portal and Orchestrator using the default or custom CA certificates
post
Returns whether or not appliance is currently using custom CA certificate trust store
get
Enable or disable custom CA certificate trust store
post
linkAggregation
Gets all link aggregation groups
get
add/updates link aggregation groups
post
Gets all link aggregation groups state details
get
Get state details of bonded interface by name
get
bfd
Get appliance BFD global level configuration data for all VRFs.
get
Get appliance BFD global level configuration data for specific VRF.
get
Set appliance's BFD global level configuration data for specific VRF.
post
Get appliance BFD state information for all VRFs.
get
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 time
get
SessionAffinityConfig
set session affinity config
post
returns session affinity configuration
get
Powered by
Gets the web Server Session Management Attributes.
get
http://localhost:3001/rest/json/webconfig
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!
