bypass
- Get bypass mode settings for an applianceget
- Toggle bypass mode for NX appliances asynchronouslypost
ospf
syncState
- Retrieve cache and database synchronization stateget
- Synchronize in-memory cache with database valuesput
license
shaper
- Get shaper settings for an applianceget
ssl
- Get all SSL certificates on the applianceget
maintenanceMode
- Get maintenance mode appliancesget
- Configure appliance maintenance modepost
ipSla
- Get current IP SLA Manager Rulesget
- Gets IP SLA Managers state detailsget
disks
- Get disk and storage controller information for an appliance.get
login
adminDistance
- Get Admin Distance Configurationget
gcpCloudDeployment
dbPartition
- Delete a database statistics table partitiondel
- Get database partition detailsget
activeSessions
- Retrieve all current active user sessionsget
- Terminate active user sessionspost
appliance
hostName
- Get the hostname of the Orchestratorget
applianceExtraInfo
IdleTime
- Clear idle timeget
- Increment session idle counterget
rbacAssignment
availabilityTimeSettings
- Configure appliance business hours for KPI availability calculationspost
- Retrieve business hour configurations for appliancespost
statsRetention
gmsWizard
- Retrieve the Getting Started Wizard configurationget
- Create or update Getting Started Wizard configurationpost
autoTunedProperties
- Get auto-tuned orchestrator propertiesget
bfd
- Retrieve BFD VRF configurationget
- Retrieve BFD session state for all VRFsget
authentication
- Get authentication order, RADIUS, and TACACS+ configurationget
spPortal
bgp
debugStats
bondedTunnelsConfiguration
rmaWizard
- Apply RMA wizard to replace an existing appliancepost
- Validate interface mapping for RMA replacementpost
securityMaps
- Retrieve Security Policies (Zone-Based Firewall Rules)get
secureWebServicesConfig
applianceCPUstats
azureCloudDeployment
nat
topologyConfig
grnode
restRequestTimeStats
- Get detailed REST request timing for a specific appliance and resourceget
- Get aggregated REST request timing statisticsget
multicast
interfaceLabels
location
- Convert address to geographic coordinates (geocoding)get
gmsNotification
gmsTreeConfig
- Get tree view display configuration for the current userget
- Create or update tree view display configuration for the current userpost
vrrp
- Get VRRP instances configured on an applianceget
applianceCrashHistory
- Get appliance crash history (Deprecated)get
apiKey
gmsPermission
- Get user permission levelget
Orchestrator High Availability
uiUsageStats
- Increment UI feature usage counterpost
session
- Get all active login sessionsget
gmsLicense
cache
- Retrieve cached built-in applicationsget
- Retrieve cached user-defined applicationsget
EdgeHAGroups
avcMode
- Get AVC Mode Statusget
statsCollection
internalSubnets
- Retrieve internal subnets configurationget
- Save internal subnets configurationpost
StatsDebug
remoteLogReceiver
liveTailLogger
- Retrieve available logger names from the Orchestratorget
scheduleTimezone
pauseOrchestration
- Get nePks of appliances paused from orchestrationget
- Set appliances to pause from orchestrationpost
availabilityThresholdSettings
- Get availability threshold settingsget
- Create or update availability threshold settingspost
actionLog
maps
- Delete an uploaded custom topology map imagepost
- Retrieve list of uploaded custom topology map imagesget
snmp
- Get SNMP configuration for an applianceget
group
realtimeStats
- Retrieve real-time tunnel stats, flow stats, packet drop stats (with reason codes), DSCP stats, traffic class stats, shaper stats, and interface stats from an EdgeConnect appliance for monitoring scripts and alertingpost
scheduledJobs2
appSystemDeployInfo
- Get Appliance System Deployment Informationget
sessionTimeout
- Get session timeout settingsget
- Update session timeout and concurrent session settingsput
vti
- Get VTI interface configurationget
dynamicTopologyConfig
- Get Dynamic Topology Configurationget
- Save Dynamic Topology Configurationpost
roles
alarm
idps
applicationGroup
brandCustomization
application
- Get application bandwidth trends and statisticsget
dnsInfo
- Get DNS domain name by IP addressget
vrf
template
timeseriesStats
neighborList
tcpdump
subnets
ikeless
exception
thirdPartyLicenses
- Retrieve third-party license informationget
overlays
fileCreation
- Upload files to Orchestratorpost
routeLabels
ipObjects
restApiConfig
- Retrieve REST API configuration settingsget
- Update REST API configuration for Orchestrator-EdgeConnect communicationpost
gmsHttpsUpload
- Upload SSL Certificate and Private Keypost
- Validate SSL Certificate and Private Keypost
inboundShaper
- Get inbound shaper settings for an applianceget
sse connector
thirdPartyTunnelsConfiguration
sslCACertificate
gmsBackup
aggregateStats
zones
advancedProperties
user
deployment
ScheduledPDFreports
- Retrieve scheduled PDF reportsget
gmsSMTP
applianceUpgrade
- Delete ECOS/VXOA imagedel
- List available ECOS/VXOA software imagesget
fastWsFailover
userAccount
- Get user accounts and active sessions for an applianceget
- Retrieve appliance password policy settingsget
discovery
- Retrieve discovery email notification configurationget
- Save discovery email notification configurationpost
logging
- Get logging settings from appliance or Orchestrator databaseget
applianceWizard
- Check wizard apply operation status for an appliance.get
- Apply wizard configuration to an appliance asynchronously.post
optimizationPolicy
- Retrieve optimization maps configurationget
linkAggregation
- Get link aggregation configurationget
vxoaHostname
- Change appliance hostnamepost
tunnelsConfiguration
applicationDefinition
qosPolicy
- Retrieve QoS policy settings for an applianceget
mgmtServices
- Get Management Services Configurationget
networkMemory
- Erase Network Memory on one or more appliancespost
loopbackOrch
acls
- Retrieve Access Control Listsget
rbacLegacyApi
regions
appliancePreconfig
awsCloudDeployment
peerPriority
- Retrieve peer priority configuration for an applianceget
applianceBackup
securitySettings
dnsProxy
- Get DNS proxy configuration for an applianceget
gmsRemoteAuth
cluster
banners
- Retrieve banner messages from an applianceget
customCerts
saveChanges
- Persist in-memory configuration changes to persistent storage on appliancespost
EST Config
modelSpec
- Retrieve appliance model specificationspost
- Get physical port names for appliance modelspost
vxlan
bridgeGroups
- Get bridge groups configurationget
gmsStatsCollection
trafficBehaviorMode
- Get traffic behavior mode statusget
saasOptimization
- Get SaaS Optimization configuration for an applianceget
- Get SaaS application subnet monitoring data including RTT and reachability statusget
health
vrfSnatMaps
- Get Inter-Segment SNAT Configurationsget
networkRoleAndSite
- Retrieve appliance network role and site informationget
- Update appliance network role and site assignmentpost
interfaceState
- Retrieve network interface state and configuration dataget
rbacDebugabilityRestApis
- Get allowed REST API endpoints for current userget
nac
- Get NAC Security Configurationget
netFlow
- Get NetFlow/IPFIX export configurationget
dhcpConfig
sslSubstituteCert
- Get SSL Substitute Certificate Configurationget
- Validate SSL Substitute Certificatepost
rbacRole
SdwanAI
End Entity Profiles
builtInPolicies
- Get built-in policy informationget
applianceResync
- Force synchronization of appliancespost
services
cipherProfile
overlayAssociation
shell
- Get the current shell access security setting on Orchestratorget
- Update the shell access security setting on Orchestratorpost
tca
- Get system threshold crossing alerts configurationget
linkIntegrity
- Start a bidirectional link integrity test between two appliancespost
- Retrieve link integrity test status for an applianceget
natPolicy
portProfiles
portForwarding
- Retrieve port forwarding rulesget
appliancesSoftwareVersions
- Get ECOS Software Versionsget
rbacApplianceAccessGroup
routePolicy
- Get route policy settingsget
wccp
ipAllowList
bridgeInterfaceState
- Get Bridge Interface Stateget
customApplianceTags
- Retrieve custom appliance tagsget
dns
- Get DNS resolver configuration for an applianceget
broadcastCli
- Broadcast CLI commands to multiple appliances asynchronouslypost
reachability
upgradeAppliances
- Upgrade EdgeConnect appliances with ECOS firmwarepost
- Validate ECOS firmware upgrade compatibility for appliancespost
configurationLimit
- Get appliance configuration limitsget
debugFiles
haGroups
- Retrieve all HA groupsget
- Save or update HA groups configurationpost
appSystemStateInfo
- Get Appliance System State Informationget
vrfDnatMaps
- Gets Inter-Segment DNAT configurations of selected applianceget
gmsServer
gmsRegistration
thirdPartyServices
releases
loopback
- Get loopback interface configurationget
httpsCertificate
- Retrieve the HTTPS certificate configuration from an applianceget
overlayManagerProperties
flow

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
- Retrieves all power supply dataget
proxyInfo
- Get Proxy information of the appliance.get
system
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
nac
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
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 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
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
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
idps
customCaCerts
linkAggregation
bridgeGroups
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
Roles
- Get Rolesget
- Post Rolepost
vxlan
poe
pki
otoSpec
- set OTO tunnel configpost
- Delete all OTO tunnelsdel
oroSpec
cachedRole
- returns role cache data collected from radius snooping and nacd sorted by user session start timeget
routeLabels
- Returns the route labelsget
- Add/Edit route labelspost
secureWebServicesConfig
- Gets secure web services configurationget
- Modifies the secure web services attributes.post
usbLte
speedTest
UserProfile
- Get Role Optionsget
- Post Role Optionspost
debug
- Returns debug information of a generic moduleget
- Deletes data of a generic moduledel
glcp
airgap
- Returns whether or not Air-gap mode is enabled on applianceget
- Enable or disable Air-gap modepost
ipAllowList
neighborList
passwordSettings
- Returns Password Settings on applianceget
- Password Settings Details.post
cipherSettings
- The active profile details from Orchestrator will be pushed to appliance. post
- Returns the active values for the current cipher settings.get
sse connector

Orchestrator REST APIs
azureCloudDeployment

Get deployment status for Azure NVA EdgeConnect in Virtual WAN hub

get

http://127.0.0.1:8080/cloudDeployment/azure-nva/edgeconnects/deploy-status

Retrieves the current deployment status, configuration details, and logs for a specific Azure NVA EdgeConnect deployment. Use this endpoint to track deployment progress, monitor deployment lifecycle states, and retrieve deployment logs for troubleshooting.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

int64

required

≥ 1

Unique identifier for the Azure NVA deployment assigned by Orchestrator. Obtain this ID from the POST /cloudDeployment/azure-nva/edgeconnects response or GET /cloudDeployment/azure-nva/edgeconnects endpoint.

Responses