| Method Signature |
Description |
Path |
Workflow? |
| actionAndAuditLogEntries(startTime, endTime, limit, logLevel, appliance, username, callback) |
Get action/audit log entries. |
{base_path}/{version}/action?{query} |
Yes |
| actionCancel(key, callback) |
Cancel action guid key |
{base_path}/{version}/action/cancel?{query} |
Yes |
| actionStatus(key, callback) |
Get status of a particular action using guid key |
{base_path}/{version}/action/status?{query} |
Yes |
| alarmAcknowledgement(neId, alarmAcknowledgementBody, callback) |
Acknowledges alarms on appliance whose sequence IDs are provided in the request body |
{base_path}/{version}/alarm/acknowledgement/appliance/{pathv1}?{query} |
Yes |
| gmsAlarmAcknowledgement(gmsAlarmAcknowledgementBody, callback) |
Acknowledges alarms whose IDs are provided in the request body |
{base_path}/{version}/alarm/acknowledgement/gms?{query} |
Yes |
| alarmApplianceGetPost(applianceAlarmGetPostBody, view = 'active', severity = 'warning', orderBySeverity, maxAlarms, from, to, callback) |
Returns active, historical, or all alarms for appliances whose ids provided in the request body |
{base_path}/{version}/alarm/appliance?{query} |
Yes |
| alarmClearance(neId, alarmClearanceBody, callback) |
Clears alarms whose sequence IDs are provided in the request body |
{base_path}/{version}/alarm/clearance/appliance/{pathv1}?{query} |
Yes |
| gmsAlarmClearance(gmsAlarmClearanceBody, callback) |
Clears alarms whose IDs are provided in the request body |
{base_path}/{version}/alarm/clearance/gms?{query} |
Yes |
| allApplianceAlarmSummary(callback) |
Returns summary of active alarms for each appliance |
{base_path}/{version}/alarm/count/appliance?{query} |
Yes |
| applianceAlarmSummary(neId, callback) |
Returns summary of active alarms for the appliance |
{base_path}/{version}/alarm/count/appliance/{pathv1}?{query} |
Yes |
| customSeverityDelete(callback) |
Delete all customized alarm severity |
{base_path}/{version}/alarm/customization/severity?{query} |
Yes |
| customSeverityGet(callback) |
Get all customized alarm severity |
{base_path}/{version}/alarm/customization/severity?{query} |
Yes |
| customSeverityPOST(requestBody, callback) |
Create customized alarm severities |
{base_path}/{version}/alarm/customization/severity?{query} |
Yes |
| customSeverityPut(requestBody, callback) |
Update customized alarm severities |
{base_path}/{version}/alarm/customization/severity?{query} |
Yes |
| singleCustomSeverityDelete(alarmTypeId, callback) |
Delete alarm severity config by alarmTypeId |
{base_path}/{version}/alarm/customization/severity/{pathv1}?{query} |
Yes |
| singleCustomSeverityGet(alarmTypeId, callback) |
Get alarm severity config by alarmTypeId |
{base_path}/{version}/alarm/customization/severity/{pathv1}?{query} |
Yes |
| alarmEmailDelayDelete(callback) |
Delete alarm email delay configuration |
{base_path}/{version}/alarm/delayEmail?{query} |
Yes |
| alarmEmailDelayGet(callback) |
Get alarm email delay configuration |
{base_path}/{version}/alarm/delayEmail?{query} |
Yes |
| alarmEmailDelayPost(requestBody, callback) |
Create alarm email delay configuration |
{base_path}/{version}/alarm/delayEmail?{query} |
Yes |
| alarmEmailDelayPut(requestBody, callback) |
Update alarm email delay configuration |
{base_path}/{version}/alarm/delayEmail?{query} |
Yes |
| alarmDescGet(format, defaultParam, callback) |
Get Orchestrator and appliance alarm descriptions |
{base_path}/{version}/alarm/description2?{query} |
Yes |
| alarmGms(view = 'active', severity = 'warning', from, to, callback) |
Returns active, closed/historical, or all Orchestrator alarms |
{base_path}/{version}/alarm/gms?{query} |
Yes |
| alarmNotification(callback) |
Returns alarm notification |
{base_path}/{version}/alarm/notification?{query} |
Yes |
| postAlarmNotification(alarmNotification, callback) |
Set alarm notification |
{base_path}/{version}/alarm/notification?{query} |
Yes |
| alarmSummary(callback) |
Returns summary of active Orchestrator alarms as well as summary of active alarms across all appliances |
{base_path}/{version}/alarm/summary?{query} |
Yes |
| alarmSummaryType(type = 'gms', callback) |
Returns summary of active Orchestrator alarms or summary of active alarms across all appliances |
{base_path}/{version}/alarm/summary/{pathv1}?{query} |
Yes |
| deleteDisabledAlarmsConfig(callback) |
Delete disabled alarms configuration |
{base_path}/{version}/alarm/suppress?{query} |
Yes |
| getAllDisabledAlarmsConfig(callback) |
Get all disabled alarms configuration |
{base_path}/{version}/alarm/suppress?{query} |
Yes |
| updateDisabledAlarmsConfig(requestBody, callback) |
Update disabled alarms configuration |
{base_path}/{version}/alarm/suppress?{query} |
Yes |
| applianceGET(callback) |
Returns information about appliance(s) managed by Orchestrator |
{base_path}/{version}/appliance?{query} |
Yes |
| adminDistanceConfig(neId, cached, callback) |
Gets Admin Distance configurations |
{base_path}/{version}/appliance/adminDistance/{pathv1}?{query} |
Yes |
| approvedAppliance(callback) |
Get the all approved appliances |
{base_path}/{version}/appliance/approved?{query} |
Yes |
| backupPost(operation, callback) |
Backup appliance configuration to Orchestrator database |
{base_path}/{version}/appliance/backup?{query} |
Yes |
| backupDelete(backupFilePk, callback) |
Delete one specified backup record from the database table. |
{base_path}/{version}/appliance/backup/{pathv1}?{query} |
Yes |
| backupGet(neId, callback) |
Get backup history. |
{base_path}/{version}/appliance/backup/{pathv1}?{query} |
Yes |
| applianceChgGr(groupPk, appliancePrimaryKeys, callback) |
Change one or more appliances' group |
{base_path}/{version}/appliance/changeGroup/{pathv1}?{query} |
Yes |
| changeAppliancePassword(nePk, username, password, callback) |
Change a user's password on appliance. |
{base_path}/{version}/appliance/changePassword/{pathv1}/{pathv2}?{query} |
Yes |
| deleteForRediscovery(nePk, callback) |
Delete for rediscovery. |
{base_path}/{version}/appliance/deleteForDiscovery/{pathv1}?{query} |
Yes |
| deniedAppliance(callback) |
Get the all denied appliances |
{base_path}/{version}/appliance/denied?{query} |
Yes |
| getAllDiscoveredAppliances(callback) |
Returns the all discovered appliances |
{base_path}/{version}/appliance/discovered?{query} |
Yes |
| addDiscoveredApplianceToOrchestrator(key, id, callback) |
Add discovered appliances to Orchestrator |
{base_path}/{version}/appliance/discovered/add/{pathv1}?{query} |
Yes |
| approveDiscoveredAppliances(key, id, callback) |
Add and approve discovered appliances |
{base_path}/{version}/appliance/discovered/approve/{pathv1}?{query} |
Yes |
| denyDiscoveredAppliances(id, callback) |
Deny discovered appliances. |
{base_path}/{version}/appliance/discovered/deny/{pathv1}?{query} |
Yes |
| updateDiscoveredAppliances(callback) |
Trigger discovered appliances update |
{base_path}/{version}/appliance/discovered/update?{query} |
Yes |
| dnsCacheConfig(neId, cached, callback) |
Gets DNS Cache configurations |
{base_path}/{version}/appliance/dnsCache/config/{pathv1}?{query} |
Yes |
| deleteApplianceExtraInfo(nePk, callback) |
Delete the extra information of an appliance |
{base_path}/{version}/appliance/extraInfo/{pathv1}?{query} |
Yes |
| getApplianceExtraInfo(nePk, callback) |
Get the extra information of an appliance |
{base_path}/{version}/appliance/extraInfo/{pathv1}?{query} |
Yes |
| saveApplianceExtraInfo(applianceExtraInfo, nePk, callback) |
Saves the extra information for the appliance |
{base_path}/{version}/appliance/extraInfo/{pathv1}?{query} |
Yes |
| bridgeInterfaceState(neId, cached, callback) |
Lists the Bridge Interfaces State and pass through Tx Interface |
{base_path}/{version}/appliance/interface/bridge/{pathv1}?{query} |
Yes |
| networkRoleAndSiteGet(neId, callback) |
To verify or change a Network Role (mesh / hub / spoke) for appliances |
{base_path}/{version}/appliance/networkRoleAndSite/{pathv1}?{query} |
Yes |
| networkRoleAndSitePost(neId, postNetworkRulesAndSites, callback) |
To verify or change a Network Role (mesh / hub / spoke) for appliances and to assign them to a site |
{base_path}/{version}/appliance/networkRoleAndSite/{pathv1}?{query} |
Yes |
| peerPriorityGet(neId, cached, callback) |
Get all peer priority data on the appliance |
{base_path}/{version}/appliance/peerPriorityList/{pathv1}?{query} |
Yes |
| checkAppliancesQueuedForDeletion(callback) |
Lists appliances ( appliance primary keys) that are queued on the Orchestrator for deletion. |
{base_path}/{version}/appliance/queuedForDeletion?{query} |
Yes |
| applianceGetAPI(nePk, url, callback) |
To communicate with appliance GET APIs directly. |
{base_path}/{version}/appliance/rest/{pathv1}?{query} |
Yes |
| appliancePostAPI(nePk, url, data, callback) |
To communicate with appliance POST APIs directly. |
{base_path}/{version}/appliance/rest/{pathv1}?{query} |
Yes |
| applianceRestore(operation, nePk, callback) |
Restore the appliance from the specified back. |
{base_path}/{version}/appliance/restore/{pathv1}?{query} |
Yes |
| saveChanges(saveChangesPostBody, callback) |
Save the configuration changes in memory to a file for an array of appliances in Orchestrator |
{base_path}/{version}/appliance/saveChanges?{query} |
Yes |
| postApplianceSaveChangesNePk(nePk, saveChangesPostBody, callback) |
Save the configuration changes in memory to a file for an appliances in Orchestrator |
{base_path}/{version}/appliance/saveChanges/{pathv1}?{query} |
Yes |
| statsConfigGet(callback) |
To get stats config which will be synchronized to appliances. |
{base_path}/{version}/appliance/statsConfig?{query} |
Yes |
| statsConfigPost(statsConfigPostData, callback) |
To modify stats config which will be synchronized to appliances. |
{base_path}/{version}/appliance/statsConfig?{query} |
Yes |
| statsConfigDefaultGet(callback) |
To get default stats config which will be synchronized to appliances. |
{base_path}/{version}/appliance/statsConfig/default?{query} |
Yes |
| wanNextHopHealthGet(neId, cached, callback) |
Get wan next hop health config on the appliance |
{base_path}/{version}/appliance/wanNextHopHealth/{pathv1}?{query} |
Yes |
| applianceDel(nePk, callback) |
Delete an appliance from network. |
{base_path}/{version}/appliance/{pathv1}?{query} |
Yes |
| applianceGetOne(nePk, callback) |
Get appliance information |
{base_path}/{version}/appliance/{pathv1}?{query} |
Yes |
| applianceChg(nePk, applianceInfo, callback) |
Modify an appliance's IP address, username, password, networkRole, and webProtocol. |
{base_path}/{version}/appliance/{pathv1}?{query} |
Yes |
| resyncAppliance(applianceKeys, callback) |
Synchronize a list of appliances. |
{base_path}/{version}/applianceResync?{query} |
Yes |
| appliancesSoftwareVersions(nePK, cached, callback) |
Returns VXOA software versions information |
{base_path}/{version}/appliancesSoftwareVersions/{pathv1}?{query} |
Yes |
| applicationGet(callback) |
Get all built-in and user-defined applications |
{base_path}/{version}/application?{query} |
Yes |
| builtin(callback) |
Get all built-in applications from all appliance |
{base_path}/{version}/application/builtin?{query} |
Yes |
| userDefined(callback) |
Get all userDefined applications from all appliance |
{base_path}/{version}/application/userDefined?{query} |
Yes |
| userDefinedConfig(neId, cached, callback) |
Get all user-defined application group on appliance |
{base_path}/{version}/application/userDefinedConfig/{pathv1}?{query} |
Yes |
| appTagsGet(resourceKey, callback) |
return user defined application groups |
{base_path}/{version}/applicationDefinition/applicationTags?{query} |
Yes |
| appTagsPost(appTagsBody, callback) |
Create user defined application groups |
{base_path}/{version}/applicationDefinition/applicationTags?{query} |
Yes |
| appGroupSearchPost(searchWildcard, callback) |
Search application groups based on wildcard and limit |
{base_path}/{version}/applicationDefinition/applicationTags/wildcard?{query} |
Yes |
| appTagsModePost(mode, callback) |
Change mode to application groups and user defined applications |
{base_path}/{version}/applicationDefinition/applicationTags/{pathv1}?{query} |
Yes |
| appSearchPost(searchWildcard, callback) |
Search applications based on wildcard and limit |
{base_path}/{version}/applicationDefinition/applications/wildcard?{query} |
Yes |
| compoundGet(resourceKey, callback) |
return user defined data for Compound classification |
{base_path}/{version}/applicationDefinition/compoundClassification?{query} |
Yes |
| compoundReorderPost(compoundIdsConfig, callback) |
Change the order of user defined application related to Compound data |
{base_path}/{version}/applicationDefinition/compoundClassification/reorder?{query} |
Yes |
| compoundDelete(id, callback) |
Delete user defined application related to Compound data |
{base_path}/{version}/applicationDefinition/compoundClassification/{pathv1}?{query} |
Yes |
| compoundPost(id, compoundConfig, callback) |
Create/modify user defined application related to Compound data |
{base_path}/{version}/applicationDefinition/compoundClassification/{pathv1}?{query} |
Yes |
| dnsGet(resourceKey, callback) |
return user defined data for Domain Name classification |
{base_path}/{version}/applicationDefinition/dnsClassification?{query} |
Yes |
| dnsDelete(domain, callback) |
Delete user defined application related to Domain Name |
{base_path}/{version}/applicationDefinition/dnsClassification/{pathv1}?{query} |
Yes |
| dnsPost(domain, dnsConfig, callback) |
Create/modify user defined application related to Domain Name |
{base_path}/{version}/applicationDefinition/dnsClassification/{pathv1}?{query} |
Yes |
| ipIntelligenceGet(resourceKey, callback) |
return user defined data for Address Map classification |
{base_path}/{version}/applicationDefinition/ipIntelligenceClassification?{query} |
Yes |
| ipIntelligenceDelete(ipStart, ipEnd, callback) |
Delete user defined application related to Address Map |
{base_path}/{version}/applicationDefinition/ipIntelligenceClassification/{pathv1}/{pathv2}?{query} |
Yes |
| ipIntelligencePost(ipStart, ipEnd, ipIntelligenceConfig, callback) |
Create/modify user defined application related to Address Map |
{base_path}/{version}/applicationDefinition/ipIntelligenceClassification/{pathv1}/{pathv2}?{query} |
Yes |
| legacyUdaGet(callback) |
return legacy UDA configuration on each appliance |
{base_path}/{version}/applicationDefinition/legacyAppliancesUdas?{query} |
Yes |
| meterFlowGet(resourceKey, callback) |
return user defined data for Meter Flow classification |
{base_path}/{version}/applicationDefinition/meterFlowClassification?{query} |
Yes |
| meterFlowDelete(flowType, mid, callback) |
Delete user defined application related to Meter Flow |
{base_path}/{version}/applicationDefinition/meterFlowClassification/{pathv1}/{pathv2}?{query} |
Yes |
| meterFlowPost(flowType, mid, meterFlowConfig, callback) |
Create/modify user defined application related to Meter Flow |
{base_path}/{version}/applicationDefinition/meterFlowClassification/{pathv1}/{pathv2}?{query} |
Yes |
| portProtocolGet(resourceKey, callback) |
return user defined data for IP/TCP/UDP classification |
{base_path}/{version}/applicationDefinition/portProtocolClassification?{query} |
Yes |
| portProtocolDelete(port, protocol, callback) |
Delete user defined application related to IP Protocol, TCP Port, UDP Port |
{base_path}/{version}/applicationDefinition/portProtocolClassification/{pathv1}/{pathv2}?{query} |
Yes |
| portProtocolPost(port, protocol, portProtocolConfig, callback) |
Create/modify user defined application related to IP Protocol, TCP Port, UDP Port |
{base_path}/{version}/applicationDefinition/portProtocolClassification/{pathv1}/{pathv2}?{query} |
Yes |
| saasGet(resourceKey, callback) |
return user defined data for SaaS classification |
{base_path}/{version}/applicationDefinition/saasClassification?{query} |
Yes |
| saasDelete(id, callback) |
Delete user defined application related to SaaS data |
{base_path}/{version}/applicationDefinition/saasClassification/{pathv1}?{query} |
Yes |
| postApplicationDefinitionSaasClassificationId(id, saasConfig, callback) |
Create/modify user defined application related to SaaS data |
{base_path}/{version}/applicationDefinition/saasClassification/{pathv1}?{query} |
Yes |
| applicationGroups(neId, cached, callback) |
Get all applicationGroups on a appliance |
{base_path}/{version}/applicationGroups/{pathv1}?{query} |
Yes |
| applicationTrends(startDate, endDate, traffic = 'optimized_traffic', bound = 'inbound', nePKList, customRangeUsed, callback) |
Returns bandwidth stats about applications |
{base_path}/{version}/applicationTrends?{query} |
Yes |
| auth(neId, cached, callback) |
Get the authentication order and authorization information |
{base_path}/{version}/authRadiusTacacs/{pathv1}?{query} |
Yes |
| authentication(user, password, callback) |
Use this api to login to Orchestrator using FORM post. Commonly used to embed orchestrator UI or proxy orchestrator login via a web proxy. |
{base_path}/{version}/authentication/login?{query} |
Yes |
| getAuthenticationLoginStatus(callback) |
Get the current authentication status of the HTTP session |
{base_path}/{version}/authentication/loginStatus?{query} |
Yes |
| postAuthenticationLoginToken(requestLoginToken, callback) |
Send a 2-factor code to user's mailbox for 2-factor authentication |
{base_path}/{version}/authentication/loginToken?{query} |
Yes |
| getAuthenticationLogout(callback) |
Logout of current HTTP session |
{base_path}/{version}/authentication/logout?{query} |
Yes |
| postAuthenticationPasswordValidation(loginToken, callback) |
Authenticate user's password only, but doesn't mark user's status as login |
{base_path}/{version}/authentication/password/validation?{query} |
Yes |
| userAuthType(loginToken, callback) |
Check the two factor authentication methods the user requires to login |
{base_path}/{version}/authentication/userAuthType?{query} |
Yes |
| userAuthTypeToken(resetPasswordToken, callback) |
Check the two factor authentication methods the user has active using a reset password token |
{base_path}/{version}/authentication/userAuthTypeToken?{query} |
Yes |
| avcMode(callback) |
Returns Orchestrator avc Mode |
{base_path}/{version}/avcMode?{query} |
Yes |
| bannerInfo(neId, cached, callback) |
Lists the banner messages on each appliance |
{base_path}/{version}/banners/{pathv1}?{query} |
Yes |
| getNeighbor(neId, callback) |
Get specific neighbor configuration data. |
{base_path}/{version}/bgp/config/neighbor/{pathv1}?{query} |
Yes |
| getBGPSystemConfig(neId, callback) |
Get BGP system configuration data. |
{base_path}/{version}/bgp/config/system/{pathv1}?{query} |
Yes |
| bGPState(neId, callback) |
Get specific appliance bgp state details. |
{base_path}/{version}/bgp/state/{pathv1}?{query} |
Yes |
| textCustomizationConfigDelete(callback) |
Delete all text brand customization configurations |
{base_path}/{version}/brandCustomization?{query} |
Yes |
| textCustomizationConfigGet(callback) |
Get text brand customization configurations |
{base_path}/{version}/brandCustomization?{query} |
Yes |
| textCustomizationConfigPost(requestBody, callback) |
Create new text brand customization configurations |
{base_path}/{version}/brandCustomization?{query} |
Yes |
| textCustomizationConfigPut(requestBody, callback) |
Update text brand customization configurations |
{base_path}/{version}/brandCustomization?{query} |
Yes |
| fileNameGet(metaData, callback) |
Return file names for all the uploaded images |
{base_path}/{version}/brandCustomization/image/?{query} |
Yes |
| imageDelete(type, callback) |
Delete image for given type of brand customization and restore default |
{base_path}/{version}/brandCustomization/image/{pathv1}?{query} |
Yes |
| imagePost(type, qqfile, qqfileFormData, callback) |
Upload image for given type of brand customization |
{base_path}/{version}/brandCustomization/image/{pathv1}?{query} |
Yes |
| putBrandCustomizationImageType(type, qqfile, qqfileFormData, callback) |
Update image for given type of brand customization |
{base_path}/{version}/brandCustomization/image/{pathv1}?{query} |
Yes |
| broadcastCliPost(operation, callback) |
Broadcasts CLI commands to all the selected appliances |
{base_path}/{version}/broadcastCli?{query} |
Yes |
| bypassPost(operation, callback) |
Toggles bypass mode - only effective on NX appliances |
{base_path}/{version}/bypass?{query} |
Yes |
| bypassGet(nePk, cached, callback) |
Get bypass mode settings of one appliance in Orchestrator. |
{base_path}/{version}/bypass/{pathv1}?{query} |
Yes |
| builtinAppGet(callback) |
Get all built in applications |
{base_path}/{version}/cache/builtinApps?{query} |
Yes |
| interfaceGet(callback) |
Get all appliances' interface endpoints' information including IP addresses. |
{base_path}/{version}/cache/interfaceEndpoints?{query} |
Yes |
| userAppGet(callback) |
Gets the user applications |
{base_path}/{version}/cache/userApps?{query} |
Yes |
| cloudAppsConfig(neId, cached, callback) |
Get SaaS Optimization configuration information for appliance |
{base_path}/{version}/cloudApplications/config/{pathv1}?{query} |
Yes |
| cloudAppsMonitor(neId, cached, callback) |
Get reachability/RTT values for SaaS App subnets enabled for advertisement |
{base_path}/{version}/cloudApplications/monitor/{pathv1}?{query} |
Yes |
| disks(neId, callback) |
Get disks information. |
{base_path}/{version}/configReportDisk/{pathv1}?{query} |
Yes |
| dbPartition(table, partition, callback) |
Gets Orchestrator database partition details |
{base_path}/{version}/dbPartition/info?{query} |
Yes |
| deletePartition(table, partition, callback) |
Deletes the table's partition |
{base_path}/{version}/dbPartition/{pathv1}/{pathv2}?{query} |
Yes |
| cancel(callback) |
Cancel download the file |
{base_path}/{version}/debugFiles/cancel?{query} |
Yes |
| deleteGMSDebugFile(deleteGMSDebugFile, callback) |
Delete the Orchestrator debug file |
{base_path}/{version}/debugFiles/delete?{query} |
Yes |
| deleteNeFile(nePk, deleteInfoClass, callback) |
Delete the debug file on the appliance |
{base_path}/{version}/debugFiles/delete/{pathv1}?{query} |
Yes |
| getProxyConfig(callback) |
Get the proxy config settings |
{base_path}/{version}/debugFiles/proxyConfig?{query} |
Yes |
| setProxyConfig(proxyConfig, callback) |
Set the proxy config settings |
{base_path}/{version}/debugFiles/proxyConfig?{query} |
Yes |
| debugFiles(nePk, callback) |
Get the debug files |
{base_path}/{version}/debugFiles/{pathv1}?{query} |
Yes |
| validateDeployment(nePk, deployment, callback) |
Validate deployment configuration |
{base_path}/{version}/deployment/validate/{pathv1}?{query} |
Yes |
| validateDiscoveredDeployment(discoveredApplianceId, deployment, callback) |
Validate deployment configuration for a discovered appliance. |
{base_path}/{version}/deployment/validateDiscovered/{pathv1}?{query} |
Yes |
| getApplianceDeployment(nePk, callback) |
Get the deployment configuration of the appliance, does a direct call to the appliance. |
{base_path}/{version}/deployment/{pathv1}?{query} |
Yes |
| dhcpConfigGet(callback) |
Get orchestrator DHCP settings |
{base_path}/{version}/dhcpConfig?{query} |
Yes |
| dhcpConfigPost(dhcpConfigPost, callback) |
Save orchestrator DHCP settings |
{base_path}/{version}/dhcpConfig?{query} |
Yes |
| dhcpdLeases(neId, cached, callback) |
Get DHCP leases information. |
{base_path}/{version}/dhcpConfig/leases/{pathv1}?{query} |
Yes |
| dhcpReservationsGet(callback) |
Get list of reserved subnets from the DHCP pool |
{base_path}/{version}/dhcpConfig/reservations?{query} |
Yes |
| dhcpReservationsPost(dhcpConfigPost, callback) |
Reserve a subnet in the DHCP pool |
{base_path}/{version}/dhcpConfig/reservations?{query} |
Yes |
| dhcpReservationsGmsPost(dhcpConfigGmsPost, callback) |
Update DHCP pool reservations list. This api can be used to clear up local reservations (that have not been configured on appliance yet) |
{base_path}/{version}/dhcpConfig/reservations/gms?{query} |
Yes |
| dhcpConfigResetPost(callback) |
Remove all DHCP pool reservations |
{base_path}/{version}/dhcpConfig/reset?{query} |
Yes |
| dhcpdFailoverStates(neId, cached, callback) |
Get dhcpd leases report of failover state |
{base_path}/{version}/dhcpConfig/state/failover/{pathv1}?{query} |
Yes |
| dnsProxyConfigGet(neId, cached, callback) |
Get the DNS proxy config |
{base_path}/{version}/dnsProxy/config/{pathv1}?{query} |
Yes |
| tunnelExceptionDelete(callback) |
Delete all tunnel exceptions |
{base_path}/{version}/exception/tunnel?{query} |
Yes |
| tunnelExceptionGet(callback) |
Get all tunnel exceptions |
{base_path}/{version}/exception/tunnel?{query} |
Yes |
| tunnelExceptionPost(requestBody, callback) |
Create tunnel exceptions |
{base_path}/{version}/exception/tunnel?{query} |
Yes |
| tunnelExceptionPut(requestBody, callback) |
Update tunnel exceptions |
{base_path}/{version}/exception/tunnel?{query} |
Yes |
| tunnelExceptionSingleDelete(id, callback) |
Delete single tunnel exceptions |
{base_path}/{version}/exception/tunnel/{pathv1}?{query} |
Yes |
| tunnelExceptionSingleUpdate(id, requestBody, callback) |
Update a single tunnel exceptions |
{base_path}/{version}/exception/tunnel/{pathv1}?{query} |
Yes |
| fileCreation(type = 'upgradeGms', qqfile, qqfileFormData, callback) |
This API is to be used with fineuploader.js plugin. See fineuploader.com |
{base_path}/{version}/fileCreation/fineUploader?{query} |
Yes |
| flowBandwidthStats(neId, id, seq, callback) |
Returns the so far accumulated bandwidth stats about the flow |
{base_path}/{version}/flow/flowBandwidthStats/{pathv1}/q?{query} |
Yes |
| flowDetails(neId, id, seq, callback) |
Returns flow details |
{base_path}/{version}/flow/flowDetails/{pathv1}/q?{query} |
Yes |
| flowDetails2(neId, id, seq, callback) |
Returns more detailed info about the flow |
{base_path}/{version}/flow/flowDetails2/{pathv1}/q?{query} |
Yes |
| flowsReclassification(neId, flowsReClassificationBody, callback) |
Reclassifies the flow(s) |
{base_path}/{version}/flow/flowReClassification/{pathv1}?{query} |
Yes |
| flowsReset(neId, flowsResetBody, callback) |
Resets the flow(s) |
{base_path}/{version}/flow/flowReset/{pathv1}?{query} |
Yes |
| flows(neId, ip1, mask1, port1, ip2, mask2, port2, ipEitherFlag, portEitherFlag, application = '3par', applicationGroup = 'Accommodation_and_Hotels', protocol = 'ip', vlan, dscp, overlays, transport, services, zone1, zone2, zoneEither, filter = 'all', edgeHA = 'false', builtIn = 'false', uptime = 'anytime', bytes = 'total', duration, anytimeSlowFlows, callback) |
Returns active, inactive, or both types of flows on the appliance based on the query parameters supplied |
{base_path}/{version}/flow/{pathv1}/q?{query} |
Yes |
| getAdvProp(callback) |
Get Orchestrator advanced properties |
{base_path}/{version}/gms/advancedProperties?{query} |
Yes |
| postAdvProp(advancedProperties, callback) |
Update Orchestrator advanced properties |
{base_path}/{version}/gms/advancedProperties?{query} |
Yes |
| getGmsAdvancedPropertiesMetadata(callback) |
Get Orchestrator metadata of the advanced properties |
{base_path}/{version}/gms/advancedProperties/metadata?{query} |
Yes |
| getPreconfigurations(filter = 'names', callback) |
Get all preconfigurations |
{base_path}/{version}/gms/appliance/preconfiguration?{query} |
Yes |
| createPreconfiguration(createPreconfig, callback) |
Create a preconfiguration |
{base_path}/{version}/gms/appliance/preconfiguration?{query} |
Yes |
| getDefaultPreconfigurations(callback) |
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 |
{base_path}/{version}/gms/appliance/preconfiguration/default?{query} |
Yes |
| getMatchingPreconfiguration(matchPreconfig, callback) |
Get the first matching preconfiguration, matching by serial then tag |
{base_path}/{version}/gms/appliance/preconfiguration/findMatch?{query} |
Yes |
| postGmsAppliancePreconfigurationValidate(createPreconfig, callback) |
Get the first matching preconfiguration, matching by serial then tag |
{base_path}/{version}/gms/appliance/preconfiguration/validate?{query} |
Yes |
| deletePreconfiguration(preconfigId, callback) |
Delete one preconfiguration |
{base_path}/{version}/gms/appliance/preconfiguration/{pathv1}?{query} |
Yes |
| getPreconfiguration(preconfigId, callback) |
Get one preconfiguration |
{base_path}/{version}/gms/appliance/preconfiguration/{pathv1}?{query} |
Yes |
| modifyPreconfiguration(createPreconfig, preconfigId, callback) |
Modify one preconfiguration |
{base_path}/{version}/gms/appliance/preconfiguration/{pathv1}?{query} |
Yes |
| getPreconfigurationApplyStatus(preconfigId, callback) |
Get the apply status of a preconfiguration |
{base_path}/{version}/gms/appliance/preconfiguration/{pathv1}/apply?{query} |
Yes |
| applyDiscoveredPreconfiguration(preconfigId, discoveredId, callback) |
Apply preconfiguration to discovered appliance |
{base_path}/{version}/gms/appliance/preconfiguration/{pathv1}/apply/discovered/{pathv2}?{query} |
Yes |
| applyManagedPreconfiguration(preconfigId, nePk, callback) |
Apply preconfiguration to an already managed appliance |
{base_path}/{version}/gms/appliance/preconfiguration/{pathv1}/apply/{pathv2}?{query} |
Yes |
| crashHistory(action, callback) |
Return or sends crash history of all the appliances |
{base_path}/{version}/gms/applianceCrashHistory?{query} |
Yes |
| rebootHistory(action, callback) |
Return or sends reboot history of all the appliances |
{base_path}/{version}/gms/applianceRebootHistory?{query} |
Yes |
| getApplyApplianceWizard(nePk, callback) |
Get the handle for the currently applying wizard. |
{base_path}/{version}/gms/applianceWizard/apply/{pathv1}?{query} |
Yes |
| applyApplianceWizard(applyWizardPost, nePk, callback) |
Applies the wizard to an appliance in the background |
{base_path}/{version}/gms/applianceWizard/apply/{pathv1}?{query} |
Yes |
| gmsBackupGet(callback) |
Returns orchestrator backup information |
{base_path}/{version}/gms/backup?{query} |
Yes |
| gmsBackupConfig(gmsBackConfig, callback) |
add or update orchestrator backup config data |
{base_path}/{version}/gms/backup/config?{query} |
Yes |
| goldenOrchestratorExport(mode, download, callback) |
Create blueprint template |
{base_path}/{version}/gms/backup/exportTemplate?{query} |
Yes |
| gmsBackupTestConnection(gmsBackConfig, callback) |
Test the orchestrator backup remote server whether can connect. |
{base_path}/{version}/gms/backup/testConnection?{query} |
Yes |
| getDiscoveryConfig(callback) |
Returns the configuration for Discovery |
{base_path}/{version}/gms/discovery?{query} |
Yes |
| updateDiscoveryConfig(emails, callback) |
Updates the discovery configuration with the object passed. Note: Replaces the whole configuration with the configuration passed |
{base_path}/{version}/gms/discovery?{query} |
Yes |
| getDynamicTopologyConfig(userName, callback) |
Returns the configuration for the dynamic topology tab. |
{base_path}/{version}/gms/dynamicTopologyConfig?{query} |
Yes |
| updateDynamicTopologyConfig(userName, request, callback) |
Updates the dynamic topology configuration for the given user |
{base_path}/{version}/gms/dynamicTopologyConfig?{query} |
Yes |
| getUserDynamicTopologyConfig(username, callback) |
Deprecated. Use the GET /gms/dynamicTopologyConfig with the userName query parameter |
{base_path}/{version}/gms/dynamicTopologyConfig/{pathv1}?{query} |
Yes |
| saveDynamicTopologyConfig(username, request, callback) |
Deprecated. Use POST /gms/dynamicTopologyConfig with the username query parameter |
{base_path}/{version}/gms/dynamicTopologyConfig/{pathv1}?{query} |
Yes |
| mgmInterfaceByGet(callback) |
Gets setting for GMS registration on appliance |
{base_path}/{version}/gms/gmsRegistration?{query} |
Yes |
| mgmInterfaceByPost(dnsDetails, callback) |
update setting for GMS registration on appliance |
{base_path}/{version}/gms/gmsRegistration?{query} |
Yes |
| getGmsGmsRegistration2(callback) |
Gets setting for GMS registration on appliance |
{base_path}/{version}/gms/gmsRegistration2?{query} |
Yes |
| postGmsGmsRegistration2(dnsDetails, callback) |
update setting for GMS registration on appliance |
{base_path}/{version}/gms/gmsRegistration2?{query} |
Yes |
| allGRNodeGet(callback) |
Get appliance positions on a map for topology |
{base_path}/{version}/gms/grNode?{query} |
Yes |
| grNodeUpdateByNePk(nePk, gRNodeUpdatePostBody, callback) |
Update appliance position by nePk |
{base_path}/{version}/gms/grNode/forNePk/{pathv1}?{query} |
Yes |
| grNodeGet(grNodePk, callback) |
Get appliance position by graphical node primary key |
{base_path}/{version}/gms/grNode/{pathv1}?{query} |
Yes |
| grNodeUpdate(grNodePk, gRNodeUpdatePostBody, callback) |
Update appliance position |
{base_path}/{version}/gms/grNode/{pathv1}?{query} |
Yes |
| allGroupsGet(callback) |
Get all orchestrator groups. A group is a logical collection of appliances managed by orchestrator |
{base_path}/{version}/gms/group?{query} |
Yes |
| groupAdd(groupNewPostBody, callback) |
Add new group |
{base_path}/{version}/gms/group/new?{query} |
Yes |
| rootGroupGet(callback) |
Get root group |
{base_path}/{version}/gms/group/root?{query} |
Yes |
| groupDelete(id, callback) |
Delete a group |
{base_path}/{version}/gms/group/{pathv1}?{query} |
Yes |
| groupGet(id, callback) |
Get a single group |
{base_path}/{version}/gms/group/{pathv1}?{query} |
Yes |
| groupUpdate(id, groupUpdatePostBody, callback) |
Update a group |
{base_path}/{version}/gms/group/{pathv1}?{query} |
Yes |
| httpsCertificateValidation(certificateKeyData, callback) |
upload the intermediate certs, certificate and key files |
{base_path}/{version}/gms/httpsCertificate?{query} |
Yes |
| postGmsHttpsCertificateValidation(certificateKeyData, callback) |
Validate the certificate and key |
{base_path}/{version}/gms/httpsCertificate/validation?{query} |
Yes |
| getInterfaceLabels(active, callback) |
Returns all the interface labels saved |
{base_path}/{version}/gms/interfaceLabels?{query} |
Yes |
| postInterfaceLabels(newLabels, deleteDependencies, callback) |
Save interface labels, will completely replace the current implementation. |
{base_path}/{version}/gms/interfaceLabels?{query} |
Yes |
| getLabelsForType(type = 'wan', active, callback) |
Returns all the labels for the given type |
{base_path}/{version}/gms/interfaceLabels/{pathv1}?{query} |
Yes |
| getInternalSubnets(callback) |
Get the internal subnets |
{base_path}/{version}/gms/internalSubnets2?{query} |
Yes |
| saveInternalSubnets(body, callback) |
Save internal subnets |
{base_path}/{version}/gms/internalSubnets2?{query} |
Yes |
| getIPWhitelistDrops(callback) |
Get the IP addresses of the dropped requests to this server |
{base_path}/{version}/gms/ipwhitelist/drops?{query} |
Yes |
| getExternalIPWhitelist(callback) |
Get the external IP/mask white list |
{base_path}/{version}/gms/ipwhitelist/external?{query} |
Yes |
| setExternalIPWhitelist(subnets, callback) |
Set the external IP/mask white list |
{base_path}/{version}/gms/ipwhitelist/external?{query} |
Yes |
| scheduledJobsGet(callback) |
Get all the scheduled jobs in Orchestrator |
{base_path}/{version}/gms/job?{query} |
Yes |
| scheduledJob2Post(scheduledJobs2Post, callback) |
Schedule a new job in Orchestrator |
{base_path}/{version}/gms/job?{query} |
Yes |
| historicalJobsGet(lastXDays, scheduleId, latest, callback) |
Get the historical jobs by parameter. If all parameter is empty. Get 1000 latest historical jobs entities. |
{base_path}/{version}/gms/job/historical?{query} |
Yes |
| historicalJobsGetById(jobId, callback) |
Get the historical job by Id. |
{base_path}/{version}/gms/job/historical/{pathv1}?{query} |
Yes |
| scheduledJobDelete(jobId, callback) |
Deletes a schedule job |
{base_path}/{version}/gms/job/{pathv1}?{query} |
Yes |
| scheduledJob2Get(jobId, callback) |
Get scheduled jobs list for one specified appliance based on the nePk Id |
{base_path}/{version}/gms/job/{pathv1}?{query} |
Yes |
| scheduledJobModify(jobId, scheduledJob2Post, callback) |
Modify a scheduled job. |
{base_path}/{version}/gms/job/{pathv1}?{query} |
Yes |
| stopJob(jobId, callback) |
Stop a scheduled job |
{base_path}/{version}/gms/job/{pathv1}/stop?{query} |
Yes |
| getAllMenuItems(callback) |
All the checked menu items with different menu type names |
{base_path}/{version}/gms/menuCustomization?{query} |
Yes |
| addMenuType(newMenuType, callback) |
Store or update the checked menu items for a special menu type name |
{base_path}/{version}/gms/menuCustomization?{query} |
Yes |
| updateMenuTypeItems(usersUpdate, callback) |
Configure users for menu types and set default menu type for monitoring users |
{base_path}/{version}/gms/menuCustomization?{query} |
Yes |
| deleteExistingMenuType(menuTypeName, callback) |
Delete the a special menu type, including its checked menu items and configured users |
{base_path}/{version}/gms/menuCustomization/{pathv1}?{query} |
Yes |
| getAllOverlayApplianceAssociations(callback) |
Get the list of appliances associated with all overlays |
{base_path}/{version}/gms/overlays/association?{query} |
Yes |
| addOverlayApplianceAssociations(associations, callback) |
Add appliances to overlays |
{base_path}/{version}/gms/overlays/association?{query} |
Yes |
| removeAppliancesFromOverlays(appliancesToRemove, callback) |
Remove appliances from overlays |
{base_path}/{version}/gms/overlays/association/remove?{query} |
Yes |
| getAppliancesForOverlay(overlayId, callback) |
Get appliances in an overlay |
{base_path}/{version}/gms/overlays/association/{pathv1}?{query} |
Yes |
| deleteOverlayApplianceAssociation(overlayId, nePk, callback) |
Remove an appliance from an overlay |
{base_path}/{version}/gms/overlays/association/{pathv1}/{pathv2}?{query} |
Yes |
| getAllOverlays(callback) |
All the overlays stored in the Orchestrator |
{base_path}/{version}/gms/overlays/config?{query} |
Yes |
| addNewOverlay(newOverlay, callback) |
Saves a new overlay to the Orchestrator |
{base_path}/{version}/gms/overlays/config?{query} |
Yes |
| getMaxNumberOfOverlays(callback) |
Get the max number of overlays |
{base_path}/{version}/gms/overlays/config/maxNumOfOverlays?{query} |
Yes |
| getAllRegionalOverlays(callback) |
All the overlays stored in the Orchestrator keyed by overlayId and regionId |
{base_path}/{version}/gms/overlays/config/regions?{query} |
Yes |
| postAllRegionalOverlays(allOverlays, callback) |
Post regional overlay configurations |
{base_path}/{version}/gms/overlays/config/regions?{query} |
Yes |
| getRegionalOverlay(overlayId, regionId, callback) |
Get regional overlay by overlayId and regionId |
{base_path}/{version}/gms/overlays/config/regions/{pathv1}/{pathv2}?{query} |
Yes |
| modifyRegionalOverlay(overlayId, regionId, overlayConfig, callback) |
Modify regional overlay |
{base_path}/{version}/gms/overlays/config/regions/{pathv1}/{pathv2}?{query} |
Yes |
| deleteExistingOverlay(overlayId, callback) |
Deletes the overlay from the Orchestrator. Removes any appliances from the overlay and deletes any reports specifically for this overlay. |
{base_path}/{version}/gms/overlays/config/{pathv1}?{query} |
Yes |
| getOverlay(overlayId, callback) |
Returns one overlay that has the id of the passed overlayId parameter |
{base_path}/{version}/gms/overlays/config/{pathv1}?{query} |
Yes |
| updateExistingOverlay(overlayId, updatedOverlay, callback) |
Update the properties of an existing overlay |
{base_path}/{version}/gms/overlays/config/{pathv1}?{query} |
Yes |
| getOverlayPriorityMap(callback) |
Get the overlay priority order |
{base_path}/{version}/gms/overlays/priority?{query} |
Yes |
| saveOverlayPriority(overlayPriority, callback) |
Change the overlay priorities |
{base_path}/{version}/gms/overlays/priority?{query} |
Yes |
| getScheduleTimezone(callback) |
Returns the configured timezone for scheduled jobs and reports |
{base_path}/{version}/gms/scheduleTimezone?{query} |
Yes |
| updateScheduleTimezone(defaultTimezone, callback) |
Updates the schedule timezone used with for the scheduled jobs and reports. |
{base_path}/{version}/gms/scheduleTimezone?{query} |
Yes |
| getServices(callback) |
Returns all the services |
{base_path}/{version}/gms/services?{query} |
Yes |
| saveServices(newServices, callback) |
Save the service list |
{base_path}/{version}/gms/services?{query} |
Yes |
| sessionTimeout(callback) |
Returns information of auto logout and max login session |
{base_path}/{version}/gms/sessionTimeout?{query} |
Yes |
| putGmsSessionTimeout(sessionDetail, callback) |
Update auto logout and max login session |
{base_path}/{version}/gms/sessionTimeout?{query} |
Yes |
| statsCollection(callback) |
Gets stats collection enable/disable details |
{base_path}/{version}/gms/statsCollection?{query} |
Yes |
| postGmsStatsCollection(statsCollection, callback) |
Used to enable/disable stats collection by orchestrator |
{base_path}/{version}/gms/statsCollection?{query} |
Yes |
| statsCollectionDefault(callback) |
To get default values for stats collection |
{base_path}/{version}/gms/statsCollection/default?{query} |
Yes |
| getThirdPartyServices(callback) |
Returns all the Third Party Services |
{base_path}/{version}/gms/thirdPartyServices?{query} |
Yes |
| getDefaultTopologyConfig(userName, callback) |
Returns the configuration for the topology tab. The key in the configuration will be the username. |
{base_path}/{version}/gms/topologyConfig?{query} |
Yes |
| updateTopologyConfig(userName, request, callback) |
Updates the topology configuration for the given user |
{base_path}/{version}/gms/topologyConfig?{query} |
Yes |
| saveMapImage(defaultParam, callback) |
Update the map image |
{base_path}/{version}/gms/topologyConfig/map?{query} |
Yes |
| getUserTopologyConfig(username, callback) |
Deprecated. Use GET /gms/topologyConfig with the username query parameter |
{base_path}/{version}/gms/topologyConfig/{pathv1}?{query} |
Yes |
| saveTopologyConfig(username, request, callback) |
Deprecated. Use POST /gms/topologyConfig with the username query parameter |
{base_path}/{version}/gms/topologyConfig/{pathv1}?{query} |
Yes |
| getAllTunnelGroupApplianceAssociations(callback) |
Get the list of all tunnel group appliance lists |
{base_path}/{version}/gms/tunnelGroups/association?{query} |
Yes |
| addTunnelGroupApplianceAssociations(associations, callback) |
Add appliances to tunnel groups |
{base_path}/{version}/gms/tunnelGroups/association?{query} |
Yes |
| getAppliancesForTunnelGroup(tunnelGroupId, callback) |
Get appliances in a tunnel group |
{base_path}/{version}/gms/tunnelGroups/association/{pathv1}?{query} |
Yes |
| deleteTunnelGroupApplianceAssociation(tunnelGroupId, nePk, callback) |
Remove an appliance from a tunnel group |
{base_path}/{version}/gms/tunnelGroups/association/{pathv1}/{pathv2}?{query} |
Yes |
| getAllTunnelGroups(callback) |
Returns all the tunnel group configurations stored in the Orchestrator |
{base_path}/{version}/gms/tunnelGroups/config?{query} |
Yes |
| addNewTunnelGroup(newTunnelGroup, callback) |
Saves a new tunnel group configuration to the Orchestrator |
{base_path}/{version}/gms/tunnelGroups/config?{query} |
Yes |
| deleteExistingTunnelGroup(id, callback) |
Deletes the tunnel group from the Orchestrator. Removes any appliances from the tunnel group. |
{base_path}/{version}/gms/tunnelGroups/config/{pathv1}?{query} |
Yes |
| getTunnelGroup(id, callback) |
Returns one tunnel group that matches the ID given |
{base_path}/{version}/gms/tunnelGroups/config/{pathv1}?{query} |
Yes |
| updateExistingTunnelGroup(id, updatedTunnelGroup, callback) |
Update the properties of an existing tunnel group |
{base_path}/{version}/gms/tunnelGroups/config/{pathv1}?{query} |
Yes |
| getTunnelGroupProperties(callback) |
Get the tunnel group management properties |
{base_path}/{version}/gms/tunnelGroups/properties?{query} |
Yes |
| setTunnelGroupProperties(tunnelGroupProperties, callback) |
Set the tunnel group management properties |
{base_path}/{version}/gms/tunnelGroups/properties?{query} |
Yes |
| versionInfo(callback) |
Returns available orchestrator versions |
{base_path}/{version}/gms/versions?{query} |
Yes |
| gmsConfig(callback) |
Returns all Orchestrator configs |
{base_path}/{version}/gmsConfig?{query} |
Yes |
| postGmsConfig(gmsConfigCreation, callback) |
Creates an Orchestrator config |
{base_path}/{version}/gmsConfig?{query} |
Yes |
| deleteGmsConfigBase(base, resourceKey, callback) |
Deletes an Orchestrator config |
{base_path}/{version}/gmsConfig/{pathv1}?{query} |
Yes |
| getGmsConfigBase(base, resourceKey, callback) |
Returns specific Orchestrator config. But a specific Orchestrator config could have multiple sub-resources, that's why it returns an array. However, If "resourceKey" is provided, response will be an object(sub-resource) instead of an array |
{base_path}/{version}/gmsConfig/{pathv1}?{query} |
Yes |
| putGmsConfigBase(base, resourceKey, gmsConfigUpdate, callback) |
Updates a versioned Orchestrator config. Current resource version number needs to be provided when updating |
{base_path}/{version}/gmsConfig/{pathv1}?{query} |
Yes |
| hostnameByGet(callback) |
Get the host name of orchestrator. |
{base_path}/{version}/gmsHostname?{query} |
Yes |
| licenseByGet(callback) |
Get current license key and information |
{base_path}/{version}/gmsLicense?{query} |
Yes |
| licenseByPut(licenseKey, callback) |
Set Orchestrator license key |
{base_path}/{version}/gmsLicense?{query} |
Yes |
| validateKey(licenseKey, callback) |
Validate a new license key |
{base_path}/{version}/gmsLicense/validation?{query} |
Yes |
| osInfo(callback) |
Returns Orchestrator Operating system type |
{base_path}/{version}/gmsOperatingSystem?{query} |
Yes |
| gmsRemoteAuthGet(callback) |
Get current Radius or TACACS+ configuration |
{base_path}/{version}/gmsRemoteAuth?{query} |
Yes |
| gmsRemoteAuthPost(remoteAuthData, callback) |
Modify Radius or TACACS+ configuration |
{base_path}/{version}/gmsRemoteAuth?{query} |
Yes |
| sMTP(callback) |
Delete custom SMTP |
{base_path}/{version}/gmsSMTP?{query} |
Yes |
| getGmsSMTP(callback) |
Gets SMTP details |
{base_path}/{version}/gmsSMTP?{query} |
Yes |
| sMTPPost(sMTPDetails, callback) |
used to set SMTP settings |
{base_path}/{version}/gmsSMTP?{query} |
Yes |
| delUnverifiedEmails(emails, callback) |
Delete unverified emails |
{base_path}/{version}/gmsSMTP/delUnverifiedEmails?{query} |
Yes |
| sendVerificationEmail(address, callback) |
Send a verification email to an email address |
{base_path}/{version}/gmsSMTP/sendVerificationEmail?{query} |
Yes |
| sMTPTestMail(sMTPDetails, callback) |
used to send test mail |
{base_path}/{version}/gmsSMTP/testEmail?{query} |
Yes |
| listUnverifiedEmails(callback) |
Get unverified email addresses |
{base_path}/{version}/gmsSMTP/unverifiedEmails?{query} |
Yes |
| verifyEmailAddress(id, callback) |
verify an email address |
{base_path}/{version}/gmsSMTP/verifyAddress?{query} |
Yes |
| gmsBriefInfo(callback) |
Returns orchestrator server information such as used disk hostname, up time, version etc... |
{base_path}/{version}/gmsserver/briefInfo?{query} |
Yes |
| hello(callback) |
Returns hello message. |
{base_path}/{version}/gmsserver/hello?{query} |
Yes |
| gmsServerInfo(callback) |
Returns orchestrator server information such as used disk space, hostname,release etc... |
{base_path}/{version}/gmsserver/info?{query} |
Yes |
| gmsPingInfo(callback) |
Returns orchestrator server information such as used disk hostname, up time, version etc... |
{base_path}/{version}/gmsserver/ping?{query} |
Yes |
| haGroupsGet(callback) |
Returns a collection of appliances paired in a HA configuration |
{base_path}/{version}/haGroups?{query} |
Yes |
| haGroupsPost(haGroups, callback) |
Modify appliances paired in a HA configuration |
{base_path}/{version}/haGroups?{query} |
Yes |
| healthSummary(healthSummaryGetPostBody, callback) |
Returns health summary of all appliances |
{base_path}/{version}/health?{query} |
Yes |
| getHealthAlarmPeriodSummary(from, to, applianceId, callback) |
Returns summary of alarms for a given appliance for that time period |
{base_path}/{version}/health/alarmPeriodSummary?{query} |
Yes |
| jitterPeriodSummary(time, overlayId, applianceId, callback) |
Returns summary of jitter for a given appliance for that time period |
{base_path}/{version}/health/jitterPeriodSummary?{query} |
Yes |
| latencyPeriodSummary(time, overlayId, applianceId, callback) |
Returns summary of latency for a given appliance for that time period |
{base_path}/{version}/health/latencyPeriodSummary?{query} |
Yes |
| lossPeriodSummary(time, overlayId, applianceId, callback) |
Returns summary of loss for a given appliance for that time period |
{base_path}/{version}/health/lossPeriodSummary?{query} |
Yes |
| mosPeriodSummary(time, overlayId, applianceId, callback) |
Returns summary of mos for a given appliance for that time period |
{base_path}/{version}/health/mosPeriodSummary?{query} |
Yes |
| applyHostname(nePk, hostName, callback) |
add/updates the gms hostname |
{base_path}/{version}/hostname/{pathv1}?{query} |
Yes |
| idleTime(callback) |
Clear idle time |
{base_path}/{version}/idle/clear?{query} |
Yes |
| getIdleIncrement(callback) |
Increment idle time |
{base_path}/{version}/idle/increment?{query} |
Yes |
| ikeless(callback) |
Get UDP IPSec key status for all appliances |
{base_path}/{version}/ikelessSeedStatus?{query} |
Yes |
| applyLabelsToAppliance(nePk, callback) |
Pushes the active interface labels on Orchestrator to appliance |
{base_path}/{version}/interfaceLabels/{pathv1}?{query} |
Yes |
| interfaceState(cached, neId, callback) |
Get node configuration data from Orchestrator database or from the specified appliance. |
{base_path}/{version}/interfaceState/{pathv1}?{query} |
Yes |
| licensing(callback) |
Retrieves NX licensed appliances |
{base_path}/{version}/license/nx?{query} |
Yes |
| getLicensePortalAppliance(callback) |
Retrieves portal licensed appliances |
{base_path}/{version}/license/portal/appliance?{query} |
Yes |
| grant(nePk, callback) |
Grant an appliance a base license via Cloud Portal |
{base_path}/{version}/license/portal/appliance/grant/{pathv1}?{query} |
Yes |
| deleteLicenseToken(nePk, callback) |
Delete an appliance's license token via the appliance |
{base_path}/{version}/license/portal/appliance/license/token/{pathv1}?{query} |
Yes |
| postLicensePortalApplianceRevokeNePk(nePk, callback) |
Revoke an appliance a base license via Cloud Portal |
{base_path}/{version}/license/portal/appliance/revoke/{pathv1}?{query} |
Yes |
| postLicensePortalEcNePk(nePk, applianceInfo, callback) |
Changes appliance boost and plus settings |
{base_path}/{version}/license/portal/ec/{pathv1}?{query} |
Yes |
| getLicensePortalSummary(callback) |
Retrieves summary of portal licensed appliances |
{base_path}/{version}/license/portal/summary?{query} |
Yes |
| getLicenseVx(callback) |
Retrieves VX licensed appliances |
{base_path}/{version}/license/vx?{query} |
Yes |
| linkIntegrityTestRun(linkIntegrityTestRun, callback) |
POST operation to start link integrity test between two appliances. |
{base_path}/{version}/linkIntegrityTest/run?{query} |
Yes |
| linkIntegrityStatus(neId, callback) |
Operation to retrieve current link integrity test status for desired appliance. |
{base_path}/{version}/linkIntegrityTest/status/{pathv1}?{query} |
Yes |
| addressLookup(address, callback) |
Lookup the latitude,longitude of an address |
{base_path}/{version}/location/addressToLocation?{query} |
Yes |
| getLoggingSettings(neId, cached, callback) |
Get logging settings form appliance or gmsdb |
{base_path}/{version}/logging/{pathv1}?{query} |
Yes |
| sessions(callback) |
Returns all the current sessions |
{base_path}/{version}/loginSessions?{query} |
Yes |
| getMaintenanceMode(callback) |
Get maintenance mode appliances |
{base_path}/{version}/maintenanceMode?{query} |
Yes |
| setMaintenanceMode(maintenanceModePostBody, callback) |
Set maintenance mode for appliances |
{base_path}/{version}/maintenanceMode?{query} |
Yes |
| deleteUploadedMap(imageName, callback) |
Delete certain uploaded map |
{base_path}/{version}/maps/deleteUploadedMap?{query} |
Yes |
| getUploadedMaps(callback) |
Get list of uploaded maps |
{base_path}/{version}/maps/getUploadedMaps?{query} |
Yes |
| multicastConfigGet(neId, cached, callback) |
Get multicast config info on the appliance |
{base_path}/{version}/multicast/config/{pathv1}?{query} |
Yes |
| multicastEnableGet(neId, cached, callback) |
Get multicast enabled info on the appliance |
{base_path}/{version}/multicast/enable/{pathv1}?{query} |
Yes |
| multicastInterfaceStateGet(neId, callback) |
Get multicast interface state info on the appliance |
{base_path}/{version}/multicast/state/interfaces/{pathv1}?{query} |
Yes |
| multicastNeighborStateGet(neId, callback) |
Get multicast neighbor state info on the appliance |
{base_path}/{version}/multicast/state/neighbors/{pathv1}?{query} |
Yes |
| multicastRouteStateGet(neId, callback) |
Get multicast route state info on the appliance |
{base_path}/{version}/multicast/state/routes/{pathv1}?{query} |
Yes |
| getAllNat(neId, cached, callback) |
Returns all NAT Config |
{base_path}/{version}/nat/{pathv1}?{query} |
Yes |
| branchNatMapsGet(neId, cached, callback) |
Get NAT Maps |
{base_path}/{version}/nat/{pathv1}/maps?{query} |
Yes |
| getAllNatPools(neId, cached, callback) |
Returns all NAT Pools |
{base_path}/{version}/nat/{pathv1}/natPools?{query} |
Yes |
| getNetFlowData(neId, cached, callback) |
Get flow export data from appliance or gmsdb |
{base_path}/{version}/netFlow/{pathv1}?{query} |
Yes |
| eraseNmPost(applianceKeys, callback) |
Erase Network Memory on one or more appliances. |
{base_path}/{version}/networkMemory?{query} |
Yes |
| delNotification(callback) |
Remove the message of notification banner. |
{base_path}/{version}/notification?{query} |
Yes |
| getNotification(callback) |
Get the message of notification banner. |
{base_path}/{version}/notification?{query} |
Yes |
| postNotification(notificationConfig, callback) |
Add or update the message of notification banner. |
{base_path}/{version}/notification?{query} |
Yes |
| getInterfaceConfigDta(neId, callback) |
Get OSPF interfaces configuration data. |
{base_path}/{version}/ospf/config/interfaces/{pathv1}?{query} |
Yes |
| getOSPFSystemConfig(neId, callback) |
Get appliance's OSPF system level configuration data. |
{base_path}/{version}/ospf/config/system/{pathv1}?{query} |
Yes |
| oSPFInterfaceStateObj(neId, callback) |
Gets the state of the OSPF interfaces. |
{base_path}/{version}/ospf/state/interfaces/{pathv1}?{query} |
Yes |
| oSPFNeighborsStateObj(neId, callback) |
Gets the state of the OSPF neighbors. |
{base_path}/{version}/ospf/state/neighbors/{pathv1}?{query} |
Yes |
| oSPFStateObj(neId, callback) |
Gets the state of the OSPF. |
{base_path}/{version}/ospf/state/system/{pathv1}?{query} |
Yes |
| getOverlayMngProps(callback) |
Get the overlay manager properties in the Orchestrator. |
{base_path}/{version}/overlayManagerProperties?{query} |
Yes |
| setOverlayMngProps(overlayManagerProperties, callback) |
Set the overlay manager properties in the Orchestrator. |
{base_path}/{version}/overlayManagerProperties?{query} |
Yes |
| portForwardingGet(neId, callback) |
Get port forwarding rules on a VXOA. |
{base_path}/{version}/portForwarding/{pathv1}?{query} |
Yes |
| portProfilesGet(callback) |
Get a list of all Deployment Profile templates |
{base_path}/{version}/portProfiles/config?{query} |
Yes |
| portProfilesPost(portProfilesPost, callback) |
Create a new Deployment Profile template |
{base_path}/{version}/portProfiles/config?{query} |
Yes |
| portProfilesDelete(portProfileId, callback) |
Delete a Deployment Profile template matching the id |
{base_path}/{version}/portProfiles/config/{pathv1}?{query} |
Yes |
| getPortProfilesConfigPortProfileId(portProfileId, callback) |
Get a Deployment Profile template matching the id |
{base_path}/{version}/portProfiles/config/{pathv1}?{query} |
Yes |
| portProfilesPut(portProfileId, portProfilesPost, callback) |
Update a Deployment Profile template matching the id |
{base_path}/{version}/portProfiles/config/{pathv1}?{query} |
Yes |
| portProfilesLabelInUseGet(labelId, labelSide = 'lan', callback) |
Check if an interface label is in use by any of the existing deployment profiles |
{base_path}/{version}/portProfiles/isLabelInUse?{query} |
Yes |
| getAllApplianceAccessGroups(assigned, callback) |
Get all appliance access groups / assets |
{base_path}/{version}/rbac/asset?{query} |
Yes |
| createOrUpdateApplianceAccessGroup(body, callback) |
Create or update appliance access group / asset. |
{base_path}/{version}/rbac/asset?{query} |
Yes |
| deleteApplianceAccessGroupByName(applianceAccessGroupName, callback) |
Delete appliance access group / asset by name |
{base_path}/{version}/rbac/asset/{pathv1}?{query} |
Yes |
| getApplianceAccessGroupByName(applianceAccessGroupName, callback) |
Get appliance access group / asset by name |
{base_path}/{version}/rbac/asset/{pathv1}?{query} |
Yes |
| getAllRbacAssignments(callback) |
Get all rbac assignments |
{base_path}/{version}/rbac/assignment?{query} |
Yes |
| createOrUpdateRbacAssignment(body, callback) |
Create or update rbacAssignment. |
{base_path}/{version}/rbac/assignment?{query} |
Yes |
| deleteRbacAssignment(username, callback) |
Delete rbacAssignment by username |
{base_path}/{version}/rbac/assignment/{pathv1}?{query} |
Yes |
| getRbacAssignmentByUsername(username, callback) |
Get rbacAssignment by username |
{base_path}/{version}/rbac/assignment/{pathv1}?{query} |
Yes |
| getAllRoles(callback) |
Get all roles. |
{base_path}/{version}/rbac/role?{query} |
Yes |
| saveRole(body, callback) |
Create role or Update existing role. |
{base_path}/{version}/rbac/role?{query} |
Yes |
| getAssignedMenus(callback) |
Get list of accessible menus |
{base_path}/{version}/rbac/role/menuAssigned?{query} |
Yes |
| deleteRoleByRoleName(roleName, callback) |
Delete role By name. If role is assigned to one or more users then API will return HTTP 423 |
{base_path}/{version}/rbac/role/{pathv1}?{query} |
Yes |
| getRoleByRoleName(roleName, callback) |
Get role by name if exists |
{base_path}/{version}/rbac/role/{pathv1}?{query} |
Yes |
| reachabilityFromAppliance(neId, callback) |
Get the reachability status from the appliance |
{base_path}/{version}/reachability/appliance/{pathv1}?{query} |
Yes |
| reachabilityFromGMS(neId, callback) |
Get the reachability status from the Orchestrator |
{base_path}/{version}/reachability/gms/{pathv1}?{query} |
Yes |
| realtimeStats(nePk, body, callback) |
Get per second statistics from a VXOA appliance |
{base_path}/{version}/realtimeStats/{pathv1}?{query} |
Yes |
| regionGet(callback) |
Get all regions |
{base_path}/{version}/regions?{query} |
Yes |
| regionPost(requestBody, callback) |
Create region |
{base_path}/{version}/regions?{query} |
Yes |
| regionAssociationGET(callback) |
Get all region association |
{base_path}/{version}/regions/appliances?{query} |
Yes |
| regionAssociationPost(requestBody, callback) |
Create region association |
{base_path}/{version}/regions/appliances?{query} |
Yes |
| getRegionsAppliancesNePkNePK(nePK, callback) |
Get region association by nePK |
{base_path}/{version}/regions/appliances/nePk/{pathv1}?{query} |
Yes |
| getRegionsAppliancesRegionIdRegionId(regionId, callback) |
Get region association by region ID |
{base_path}/{version}/regions/appliances/regionId/{pathv1}?{query} |
Yes |
| regionAssociationPut(nePK, requestBody, callback) |
Update region association |
{base_path}/{version}/regions/appliances/{pathv1}?{query} |
Yes |
| regionDelete(regionId, callback) |
Delete region by regionId |
{base_path}/{version}/regions/{pathv1}?{query} |
Yes |
| regionSingleGet(regionId, callback) |
Get region by regionId |
{base_path}/{version}/regions/{pathv1}?{query} |
Yes |
| regionPut(regionId, requestBody, callback) |
Update regions |
{base_path}/{version}/regions/{pathv1}?{query} |
Yes |
| releases(filter, callback) |
Gets all the Releases for orchestrator and vxoa |
{base_path}/{version}/release?{query} |
Yes |
| releaseNotifications(callback) |
Get release notifications |
{base_path}/{version}/release/notifications?{query} |
Yes |
| delayReleaseNotification(version, delayRequest, callback) |
Delay a release notification |
{base_path}/{version}/release/notifications/delay/{pathv1}?{query} |
Yes |
| dismissReleaseNotification(version, callback) |
Dismiss a release notification |
{base_path}/{version}/release/notifications/dismiss/{pathv1}?{query} |
Yes |
| remoteLogReceiverGet(callback) |
To get all remote log receiver configurations |
{base_path}/{version}/remoteLogReceiver?{query} |
Yes |
| remoteLogReceiverAdd(requestBody, callback) |
Add remote log receiver(s) with configuration provided in the request body |
{base_path}/{version}/remoteLogReceiver?{query} |
Yes |
| remoteLogReceiverPut(requestBody, callback) |
Update remote log receiver(s) with data provided in the request body |
{base_path}/{version}/remoteLogReceiver?{query} |
Yes |
| remoteLogReceiverDelete(receiverId, callback) |
Delete a remote log receiver |
{base_path}/{version}/remoteLogReceiver/{pathv1}?{query} |
Yes |
| remoteLogReceiverSubscribe(receiverId, fetchingParam, callback) |
To query specific log(s) with log type and sequence id(s) provided in the request body |
{base_path}/{version}/remoteLogReceiver/{pathv1}/subscribe?{query} |
Yes |
| dns(neId, cached, callback) |
Get the current DNS IP address and domain names configured for an appliance. |
{base_path}/{version}/resolver/{pathv1}?{query} |
Yes |
| restApiConfigGet(callback) |
Get the REST API config |
{base_path}/{version}/restApiConfig?{query} |
Yes |
| restApiConfigPost(restApiConfigPost, callback) |
Set the REST API config |
{base_path}/{version}/restApiConfig?{query} |
Yes |
| getRestRequestTimeStatsSummary(nePk, resource, portalWS, timedout, from, to, callback) |
Returns summary of time used info of rest requests sent to appliances |
{base_path}/{version}/restRequestTimeStats/summary?{query} |
Yes |
| getRestRequestTimeStatsDetails(nePk, resource, portalWS, method = 'GET', from, to, callback) |
The time used details of all rest requests sent to an appliance's specific resource through portal web socket or web socket |
{base_path}/{version}/restRequestTimeStats/{pathv1}/%2F{pathv2}/{pathv3}/{pathv4}?{query} |
Yes |
| applyRmaWizard(applyRmaWizard, nePk, callback) |
Applies the RMA wizard |
{base_path}/{version}/rmaWizard/apply/{pathv1}?{query} |
Yes |
| samap(nePk, callback) |
Get built-in policy information |
{base_path}/{version}/saMap/{pathv1}?{query} |
Yes |
| securityMaps(neId, cached, callback) |
Get Security Policies configured on the appliance |
{base_path}/{version}/securityMaps/{pathv1}?{query} |
Yes |
| getSessionActiveSessions(callback) |
Returns all the current active sessions |
{base_path}/{version}/session/activeSessions?{query} |
Yes |
| snmpGet(nePk, cached, callback) |
Get SNMP information. |
{base_path}/{version}/snmp/{pathv1}?{query} |
Yes |
| spPortalAccountKeyChangeCount(callback) |
Number of times account key has been changed |
{base_path}/{version}/spPortal/account/key/changeCount?{query} |
Yes |
| spPortalAccountKeyChangeStatus(callback) |
Current account key change status |
{base_path}/{version}/spPortal/account/key/changeStatus?{query} |
Yes |
| spPortalAccountKeyGeneratePut(callback) |
Request Portal to generate a new account key |
{base_path}/{version}/spPortal/account/key/generate?{query} |
Yes |
| spPortalECSPLicenseAssign(spPortalECSPLicenseAssign, callback) |
Assign EC-SP licenses on Portal |
{base_path}/{version}/spPortal/account/license/appliance/ecsp/assign?{query} |
Yes |
| spPortalECSPLicensesGet(callback) |
Get EC-SP licenses from Portal |
{base_path}/{version}/spPortal/account/license/appliance/ecsp/status?{query} |
Yes |
| spPortalECSPLicenseUnassign(spPortalECSPLicenseUnassign, callback) |
Unassign EC-SP licenses on Portal |
{base_path}/{version}/spPortal/account/license/appliance/ecsp/unassign?{query} |
Yes |
| spPortalAccountLicenseFeatureGet(callback) |
Get account license feature from Portal |
{base_path}/{version}/spPortal/account/license/feature?{query} |
Yes |
| spPortalAccountLicenseTypeGet(callback) |
Get account license type from Portal |
{base_path}/{version}/spPortal/account/license/type?{query} |
Yes |
| spPortalDeleteOldKey(callback) |
Delete old account key from Portal |
{base_path}/{version}/spPortal/account/oldKey?{query} |
Yes |
| checkApplianceReachabilityUsingWSGet(neId, callback) |
Test if appliance is reachable via websocket from orchestrator |
{base_path}/{version}/spPortal/applianceWSStatus/{pathv1}?{query} |
Yes |
| appGroupTmpGet(callback) |
Get application groups from portal |
{base_path}/{version}/spPortal/applicationTags?{query} |
Yes |
| appGroupTmpHashCodeGet(callback) |
Get the hash code for application groups data from portal |
{base_path}/{version}/spPortal/applicationTags/info?{query} |
Yes |
| compoundTmpGet(callback) |
Get application definition for Compound data from portal |
{base_path}/{version}/spPortal/compoundClassification?{query} |
Yes |
| compoundTmpHashCodeGet(callback) |
Get the hash code for application definition data for Compound data from portal |
{base_path}/{version}/spPortal/compoundClassification/info?{query} |
Yes |
| spPortalConfigGet(callback) |
Get Silver Peak Cloud Portal registration information |
{base_path}/{version}/spPortal/config?{query} |
Yes |
| spPortalConfigPost(spPortalConfig, callback) |
Post Silver Peak Cloud Portal registration information |
{base_path}/{version}/spPortal/config?{query} |
Yes |
| connectivityGet(callback) |
Get Orchestrator to Silver Peak Portal connectivity status |
{base_path}/{version}/spPortal/connectivity?{query} |
Yes |
| spPortalCreateCasePost(spPortalCreateCaseWithPortal, callback) |
Create a case |
{base_path}/{version}/spPortal/createCaseWithPortal?{query} |
Yes |
| dnsTmpGet(callback) |
Get application definition for Domain Name from portal |
{base_path}/{version}/spPortal/dnsClassification?{query} |
Yes |
| dnsTmpHashCodeGet(callback) |
Get the hash code for application definition data for Domain Name from portal |
{base_path}/{version}/spPortal/dnsClassification/info?{query} |
Yes |
| geoLocationPost(geoLocationPostBody, callback) |
Get geolocation information for multiple ip's from portal |
{base_path}/{version}/spPortal/internetDb/geoLocateIp?{query} |
Yes |
| geoLocationGet(ip, callback) |
Get geolocation information for a single ip from portal |
{base_path}/{version}/spPortal/internetDb/geoLocateIp/{pathv1}?{query} |
Yes |
| ipIntelligenceTmpGet(start, limit, callback) |
Get application definition data for Address Map from portal |
{base_path}/{version}/spPortal/internetDb/ipIntelligence?{query} |
Yes |
| ipIntelligenceTmpTimeGet(callback) |
Get the last update time for application definition data for Address Map from portal |
{base_path}/{version}/spPortal/internetDb/ipIntelligence/info?{query} |
Yes |
| getSpPortalInternetDbIpIntelligenceSearch(ip, filter, callback) |
Search application definition data for Address Map from portal |
{base_path}/{version}/spPortal/internetDb/ipIntelligence/search?{query} |
Yes |
| ipIntelligenceTmpTotal(callback) |
Get count for application definition data for Address Map from portal |
{base_path}/{version}/spPortal/internetDb/ipIntelligence/total?{query} |
Yes |
| serviceIdToSaasIdGet(matchAny, org, serviceIds, top, callback) |
Get service id to service details mapping |
{base_path}/{version}/spPortal/internetDb/serviceIdToSaasId?{query} |
Yes |
| serviceIdToSaasIdCountGet(callback) |
Get count of internet services on this appliance |
{base_path}/{version}/spPortal/internetDb/serviceIdToSaasId/count?{query} |
Yes |
| serviceIdToSaasIdCountriesGet(callback) |
Get a list of unique countries in the internet services database |
{base_path}/{version}/spPortal/internetDb/serviceIdToSaasId/countries?{query} |
Yes |
| serviceIdToSaasIdSaasAppGet(callback) |
Get a list of unique saas applications in the internet services database |
{base_path}/{version}/spPortal/internetDb/serviceIdToSaasId/saasApps?{query} |
Yes |
| ipProtocolNumbersGet(callback) |
Get IP Protocol Numbers data |
{base_path}/{version}/spPortal/ipProtocolNumbers?{query} |
Yes |
| meterFlowTmpGet(callback) |
Get application definition for Meter Flow from portal |
{base_path}/{version}/spPortal/meterFlowClassification?{query} |
Yes |
| meterFlowTmpHashCodeGet(callback) |
Get the hash code for application definition data for Meter Flow from portal |
{base_path}/{version}/spPortal/meterFlowClassification/info?{query} |
Yes |
| portProtocolTmpGet(callback) |
Get application definition for IP Protocol, TCP Port, UDP Port from portal |
{base_path}/{version}/spPortal/portProtocolClassification?{query} |
Yes |
| portProtocolTmpHashCodeGet(callback) |
Get the hash code for application definition data for IP Protocol, TCP Port, UDP Port from portal |
{base_path}/{version}/spPortal/portProtocolClassification/info?{query} |
Yes |
| gmsPortalRegistrationGet(callback) |
Get current GMS-Portal registration status |
{base_path}/{version}/spPortal/registration?{query} |
Yes |
| gmsPortalRegistrationPost(callback) |
Initiate GMS-Portal Registration |
{base_path}/{version}/spPortal/registration?{query} |
Yes |
| saasTmpGet(callback) |
Get application definition for SaaS data from portal |
{base_path}/{version}/spPortal/saasClassification?{query} |
Yes |
| saasTmpHashCodeGet(callback) |
Get the hash code for application definition data for SaaS data from portal |
{base_path}/{version}/spPortal/saasClassification/info?{query} |
Yes |
| spPortalStatusGet(callback) |
Debug API to view current status of all Portal related services |
{base_path}/{version}/spPortal/status?{query} |
Yes |
| tcpUdpPortsGet(callback) |
Get TCP/UDP ports data |
{base_path}/{version}/spPortal/tcpUdpPorts?{query} |
Yes |
| topSitesGet(callback) |
Get list of top internet sites |
{base_path}/{version}/spPortal/topSites?{query} |
Yes |
| tbTmpGet(callback) |
Get traffic behavior categories from portal |
{base_path}/{version}/spPortal/trafficBehavior?{query} |
Yes |
| tbTmpHashCodeGet(callback) |
Get the hash code for traffic behavior categories data from portal |
{base_path}/{version}/spPortal/trafficBehavior/info?{query} |
Yes |
| sslCertsGet(neId, cached, callback) |
Get all SSL certificates on the appliance |
{base_path}/{version}/ssl/{pathv1}?{query} |
Yes |
| sslCACertGetTextPost(sslCACertsFile, callback) |
This API will take certificate date and return certificate information in text |
{base_path}/{version}/sslCACertificate/getText?{query} |
Yes |
| sslCACertValidation(sslCACertValidation, callback) |
Validate the SSL CA certificate file. |
{base_path}/{version}/sslCACertificate/validation?{query} |
Yes |
| sslCACerts(neId, cached, callback) |
Get all CA SSL certificates on the appliance. |
{base_path}/{version}/sslCACertificate/{pathv1}?{query} |
Yes |
| sslCertGetInfoPost(sslCertGetInfoPost, callback) |
This API will take certificate date and return certificate information |
{base_path}/{version}/sslCertificate/getInfo?{query} |
Yes |
| sslCertGetTextPost(sslCertGetTextPost, callback) |
This API will take certificate date and return certificate information in text |
{base_path}/{version}/sslCertificate/getText?{query} |
Yes |
| sslSubstituteCertValidation(sslSubstituteCertValidation, callback) |
Validate the SSL Substitute certificate |
{base_path}/{version}/sslSubstituteCertificate/validation?{query} |
Yes |
| sslSubstituteCertGet(id, cached, callback) |
Get all SSL Substitute certificates on the appliance. |
{base_path}/{version}/sslSubstituteCertificate/{pathv1}?{query} |
Yes |
| statsAggregateTunnel(startTime, endTime, granularity = 'minute', groupPk, trafficType = 'optimized_traffic', ip, metric = 'throughput', top, format = 'CSV', groupByNE, callback) |
Get aggregate appliance stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/appliance?{query} |
Yes |
| postStatsAggregateAppliance(applianceIDs, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', ip, metric = 'throughput', top, format = 'csv', groupByNE, callback) |
Get aggregate appliance stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/appliance?{query} |
Yes |
| getStatsAggregateApplianceNePk(nePk, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', ip, metric = 'throughput', top, format = 'csv', groupByNE, callback) |
Get aggregate appliance stats data for a single appliance filter by query parameters. |
{base_path}/{version}/stats/aggregate/appliance/{pathv1}?{query} |
Yes |
| statsAggregateApplication(startTime, endTime, granularity = 'minute', groupPk, application, trafficType = 'optimized_traffic', ip, metric = 'throughput', top, format = 'CSV', groupByNE, callback) |
Get aggregate application stats data filter by query parameters |
{base_path}/{version}/stats/aggregate/application?{query} |
Yes |
| postStatsAggregateApplication(applianceIDs, startTime, endTime, granularity = 'minute', application, trafficType = 'optimized_traffic', ip, metric = 'throughput', top, format = 'csv', groupByNE, callback) |
Get aggregate application stats data filter by query parameters |
{base_path}/{version}/stats/aggregate/application?{query} |
Yes |
| getStatsAggregateApplicationNePk(nePk, startTime, endTime, granularity = 'minute', application, trafficType = 'optimized_traffic', ip, metric = 'throughput', top, format = 'csv', callback) |
Get aggregate application stats data for a single appliance filter by query parameters |
{base_path}/{version}/stats/aggregate/application/{pathv1}?{query} |
Yes |
| getStatsAggregateApplication2(startTime, endTime, groupPk, application, top, format = 'CSV', groupByNE, callback) |
Get aggregate application stats data filter by query parameters |
{base_path}/{version}/stats/aggregate/application2?{query} |
Yes |
| postStatsAggregateApplication2(applianceIDs, startTime, endTime, application, top, format = 'csv', groupByNE, callback) |
Get aggregate application stats data filter by query parameters |
{base_path}/{version}/stats/aggregate/application2?{query} |
Yes |
| getStatsAggregateApplication2NePk(nePk, startTime, endTime, application, top, format = 'csv', callback) |
Get aggregate application stats data for a single appliance filter by query parameters |
{base_path}/{version}/stats/aggregate/application2/{pathv1}?{query} |
Yes |
| boostAggregateStats(applianceIDs, startTime, endTime, granularity = 'minute', top, format = 'csv', groupByNE, callback) |
Get aggregate boost stats data |
{base_path}/{version}/stats/aggregate/boost?{query} |
Yes |
| getStatsAggregateBoostNePk(nePk, startTime, endTime, granularity = 'minute', tunnelName, top, overlay, format = 'csv', groupByNE, callback) |
Get aggregate boost stats data |
{base_path}/{version}/stats/aggregate/boost/{pathv1}?{query} |
Yes |
| dNSStatsAggregate(startTime, endTime, isSource = '0', splitType, top, splitByNe, groupBy, groupBySubDomains, format = 'csv', callback) |
Get aggregate dns stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/dns?{query} |
Yes |
| statsAggregateDns(applianceIDs, startTime, endTime, isSource = '0', splitType, top, splitByNe, groupBy, groupBySubDomains, callback) |
Get aggregate dns stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/dns?{query} |
Yes |
| getStatsAggregateDnsNePk(nePk, startTime, endTime, isSource = '0', splitType, top, splitByNe, groupBy, groupBySubDomains, callback) |
Get aggregate dns stats data for a single appliance filter by query parameters. |
{base_path}/{version}/stats/aggregate/dns/{pathv1}?{query} |
Yes |
| statsAggregateDrcTunnel(startTime, endTime, granularity = 'minute', groupPk, top, overlay, format = 'CSV', groupByNE, callback) |
Get aggregate tunnel drc stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/drc?{query} |
Yes |
| statsDrcAggregateTunnel(applianceIDs, startTime, endTime, granularity = 'minute', top, overlay, format = 'csv', groupByNE, callback) |
Get aggregate tunnel drc stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/drc?{query} |
Yes |
| getStatsAggregateDrcNePk(nePk, startTime, endTime, granularity = 'minute', tunnelName, top, overlay, format = 'csv', groupByNE, callback) |
Get aggregate tunnel drc stats data for a single appliance filter by query parameters. |
{base_path}/{version}/stats/aggregate/drc/{pathv1}?{query} |
Yes |
| statsAggregateDscp(startTime, endTime, granularity = 'minute', groupPk, dscp, trafficType = 'optimized_traffic', ip, metric = 'throughput', top, format = 'CSV', groupByNE, callback) |
Get aggregate dscp stats data filter by query parameters |
{base_path}/{version}/stats/aggregate/dscp?{query} |
Yes |
| postStatsAggregateDscp(applianceIDs, startTime, endTime, granularity = 'minute', dscp, trafficType = 'optimized_traffic', ip, metric = 'throughput', top, format = 'csv', groupByNE, callback) |
Get aggregate dscp stats data filter by query parameters |
{base_path}/{version}/stats/aggregate/dscp?{query} |
Yes |
| getStatsAggregateDscpNePk(nePk, startTime, endTime, trafficType = 'optimized_traffic', granularity = 'minute', trafficClass, dscp, ip, metric = 'throughput', top, format = 'csv', callback) |
Get aggregate dscp stats data for a single appliance filter by query parameters |
{base_path}/{version}/stats/aggregate/dscp/{pathv1}?{query} |
Yes |
| statsAggregateFlow(startTime, endTime, granularity = 'minute', groupPk, flow = 'TCP_ACCELERATED', trafficType = 'optimized_traffic', ip, format = 'CSV', groupByNE, callback) |
Get aggregate flow stats data filter by query parameters |
{base_path}/{version}/stats/aggregate/flow?{query} |
Yes |
| postStatsAggregateFlow(applianceIDs, startTime, endTime, granularity = 'minute', flow = 'TCP_ACCELERATED', trafficType = 'optimized_traffic', ip, format = 'csv', groupByNE, callback) |
Get aggregate flow stats data filter by query parameters |
{base_path}/{version}/stats/aggregate/flow?{query} |
Yes |
| getActiveFlowCounts(applianceIDs, top, callback) |
Get active flow counts by NE id |
{base_path}/{version}/stats/aggregate/flow/active?{query} |
Yes |
| getStatsAggregateFlowNePk(nePk, startTime, endTime, granularity = 'minute', trafficClass, flow = 'TCP_ACCELERATED', ip, format = 'csv', callback) |
Get aggregate flow stats data for a single appliance filter by query parameters |
{base_path}/{version}/stats/aggregate/flow/{pathv1}?{query} |
Yes |
| interfaceAggregateStats(startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', format = 'csv', callback) |
Get aggregate interface stats data for a all appliance filter by query parameters |
{base_path}/{version}/stats/aggregate/interface?{query} |
Yes |
| postStatsAggregateInterface(applianceIDs, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', format = 'csv', callback) |
Get aggregate interface stats data |
{base_path}/{version}/stats/aggregate/interface?{query} |
Yes |
| interfaceOverlayTransportAggregateStats(applianceIDs, startTime, endTime, granularity = 'minute', interfaceName, overlay, format = 'csv', callback) |
Get aggregate interface overlay transport stats data |
{base_path}/{version}/stats/aggregate/interfaceOverlay?{query} |
Yes |
| jitterStatsAggregate(startTime, endTime, granularity = 'minute', ip, overlay, groupByNE, format = 'csv', callback) |
Get aggregate jitter stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/jitter?{query} |
Yes |
| statsAggregateJitter(applianceIDs, startTime, endTime, granularity = 'minute', ip, top, overlay, groupByNE, format = 'csv', callback) |
Get aggregate jitter stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/jitter?{query} |
Yes |
| getStatsAggregateJitterNePk(nePk, startTime, endTime, granularity = 'minute', ip, overlay, groupByNE, tunnelName, format = 'csv', callback) |
Get aggregate jitter stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/jitter/{pathv1}?{query} |
Yes |
| mosAggregateStats(applianceIDs, startTime, endTime, granularity = 'minute', top, overlay, format = 'csv', groupByNE, callback) |
Get aggregate Mean Opinion Score stats data |
{base_path}/{version}/stats/aggregate/mos?{query} |
Yes |
| getStatsAggregateMosNePk(nePk, startTime, endTime, granularity = 'minute', tunnelName, top, overlay, format = 'csv', groupByNE, callback) |
Get aggregate Mean Opinion Score stats data |
{base_path}/{version}/stats/aggregate/mos/{pathv1}?{query} |
Yes |
| portStatsAggregate(startTime, endTime, isSource = '0', isKnown = '0', protocol, port, top, splitByNe, lastHour, format = 'csv', callback) |
Get aggregate ports stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/ports?{query} |
Yes |
| statsAggregatePorts(applianceIDs, startTime, endTime, isSource = '0', isKnown = '0', protocol, port, top, splitByNe, lastHour, callback) |
Get aggregate ports stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/ports?{query} |
Yes |
| getStatsAggregatePortsNePk(startTime, endTime, isSource = '0', isKnown = '0', protocol, port, top, splitByNe, lastHour, callback) |
Get aggregate ports stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/ports/{pathv1}?{query} |
Yes |
| securityPolicyAggregateStats(applianceIDs, startTime, endTime, granularity = 'minute', top, format = 'csv', groupByNE, callback) |
Get aggregate security policy stats data |
{base_path}/{version}/stats/aggregate/securityPolicy?{query} |
Yes |
| getStatsAggregateSecurityPolicyNePk(nePk, startTime, endTime, granularity = 'minute', fromZone, toZone, top, format = 'csv', groupByNE, callback) |
Get aggregate security policy stats data |
{base_path}/{version}/stats/aggregate/securityPolicy/{pathv1}?{query} |
Yes |
| topTalkersStatsAggregate(startTime, endTime, top, splitByNe, format = 'csv', callback) |
Get aggregate topTalkers stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/topTalkers?{query} |
Yes |
| statsAggregateTopTalkers(applianceIDs, startTime, endTime, top, splitByNe, format = 'csv', callback) |
Get aggregate topTalkers stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/topTalkers?{query} |
Yes |
| getStatsAggregateTopTalkersSplitNePk(nePk, startTime, endTime, sourceIp, callback) |
Get aggregate topTalkers stats data for a single appliance filter by query parameters. |
{base_path}/{version}/stats/aggregate/topTalkers/split/{pathv1}?{query} |
Yes |
| getStatsAggregateTopTalkersNePk(nePk, startTime, endTime, top, callback) |
Get aggregate topTalkers stats data for a single appliance filter by query parameters. |
{base_path}/{version}/stats/aggregate/topTalkers/{pathv1}?{query} |
Yes |
| trafficBehavior(startTime, endTime, groupPk, behavioralCate, format = 'CSV', callback) |
Get aggregate Traffic Behavioral stats data filter by query parameters |
{base_path}/{version}/stats/aggregate/trafficBehavior?{query} |
Yes |
| postStatsAggregateTrafficBehavior(applianceIDs, startTime, endTime, behavioralCate, application, format = 'CSV', top, lastHour, isAggregated, callback) |
Get aggregate Traffic Behavioral stats data for a single appliance filter by query parameters |
{base_path}/{version}/stats/aggregate/trafficBehavior?{query} |
Yes |
| getStatsAggregateTrafficBehaviorNePk(nePk, startTime, endTime, behavioralCate, application, top, lastHour, callback) |
Get aggregate Traffic Behavioral stats data filter by query parameters |
{base_path}/{version}/stats/aggregate/trafficBehavior/{pathv1}?{query} |
Yes |
| statsAggregateTrafficClass(startTime, endTime, granularity = 'minute', groupPk, trafficClass, trafficType = 'optimized_traffic', ip, metric = 'throughput', top, format = 'CSV', groupByNE, callback) |
Get aggregate traffic class stats data filter by query parameters |
{base_path}/{version}/stats/aggregate/trafficClass?{query} |
Yes |
| postStatsAggregateTrafficClass(applianceIDs, startTime, endTime, granularity = 'minute', trafficClass, trafficType = 'optimized_traffic', ip, metric = 'throughput', top, format = 'csv', groupByNE, callback) |
Get aggregate traffic class stats data filter by query parameters |
{base_path}/{version}/stats/aggregate/trafficClass?{query} |
Yes |
| getStatsAggregateTrafficClassNePk(nePk, startTime, endTime, granularity = 'minute', trafficClass, trafficType = 'optimized_traffic', ip, metric = 'throughput', top, format = 'csv', callback) |
Get aggregate trafficClass stats data for a single appliance filter by query parameters |
{base_path}/{version}/stats/aggregate/trafficClass/{pathv1}?{query} |
Yes |
| getStatsAggregateTunnel(startTime, endTime, granularity = 'minute', groupPk, ip, metric = 'throughput', top, overlay, format = 'CSV', groupByNE, callback) |
Get aggregate tunnel stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/tunnel?{query} |
Yes |
| postStatsAggregateTunnel(applianceIDs, startTime, endTime, granularity = 'minute', ip, metric = 'throughput', top, overlay, format = 'csv', groupByNE, callback) |
Get aggregate tunnel stats data filter by query parameters. |
{base_path}/{version}/stats/aggregate/tunnel?{query} |
Yes |
| getStatsAggregateTunnelNePk(nePk, startTime, endTime, granularity = 'minute', tunnelName, ip, metric = 'throughput', top, overlay, format = 'csv', groupByNE, callback) |
Get aggregate tunnel stats data for a single appliance filter by query parameters. |
{base_path}/{version}/stats/aggregate/tunnel/{pathv1}?{query} |
Yes |
| statsDnsInfo(ip, callback) |
Get domain name by IP address from dns stats table |
{base_path}/{version}/stats/dnsInfo/{pathv1}?{query} |
Yes |
| statsTimeseriesAppliance(startTime, endTime, granularity = 'minute', groupPk, trafficType = 'optimized_traffic', limit, format = 'CSV', ip, latest, callback) |
Get appliance time series stats data filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/appliance?{query} |
Yes |
| postStatsTimeseriesAppliance(applianceIDs, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', limit, format = 'CSV', ip, latest, callback) |
Get appliance time series stats data filter by certain query parameters and certain appliance IDs. |
{base_path}/{version}/stats/timeseries/appliance?{query} |
Yes |
| getStatsTimeseriesApplianceNePk(nePk, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', limit, format = 'CSV', ip, latest, callback) |
Get appliance time series stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/appliance/{pathv1}?{query} |
Yes |
| statsOfApplianceProcessState(nePk, callback) |
Stats of appliance Process State. |
{base_path}/{version}/stats/timeseries/applianceProcessState/{pathv1}?{query} |
Yes |
| statsTimeseriesApplication(startTime, endTime, granularity = 'minute', groupPk, trafficType = 'optimized_traffic', application, limit, format = 'CSV', ip, latest, callback) |
Get application time series stats data filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/application?{query} |
Yes |
| postStatsTimeseriesApplication(applianceIDs, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', application, limit, format = 'CSV', ip, latest, callback) |
Get application time series stats data filter by certain query parameters and certain appliance IDs. |
{base_path}/{version}/stats/timeseries/application?{query} |
Yes |
| getStatsTimeseriesApplicationNePk(nePk, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', application, limit, format = 'CSV', ip, latest, callback) |
Get application time series stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/application/{pathv1}?{query} |
Yes |
| getStatsTimeseriesApplication2(startTime, endTime, application, groupPk, format = 'CSV', total, latest, callback) |
Get new application time series stats data filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/application2?{query} |
Yes |
| postStatsTimeseriesApplication2(applianceIDs, startTime, endTime, application, format = 'CSV', total, latest, callback) |
Get new application time series stats data filter by certain query parameters and certain appliance IDs. |
{base_path}/{version}/stats/timeseries/application2?{query} |
Yes |
| getStatsTimeseriesApplication2NePk(nePk, startTime, endTime, application, total, format = 'CSV', callback) |
Get new application time series stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/application2/{pathv1}?{query} |
Yes |
| boostTimeSeriesStats(nePk, startTime, endTime, granularity = 'minute', limit, callback) |
Get boost time series stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/boost/{pathv1}?{query} |
Yes |
| statsTimeseriesDrcTunnel(startTime, endTime, granularity = 'minute', groupPk, limit, format = 'CSV', ip, latest, callback) |
Get tunnel drc time series stats data filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/drc?{query} |
Yes |
| postStatsTimeseriesDrc(applianceIDs, startTime, endTime, granularity = 'minute', limit, format = 'CSV', ip, latest, callback) |
Get tunnel time series drc stats data filter by certain query parameters and certain appliance IDs. |
{base_path}/{version}/stats/timeseries/drc?{query} |
Yes |
| getStatsTimeseriesDrcNePk(nePk, startTime, endTime, granularity = 'minute', tunnelName, limit, format = 'CSV', ip, latest, callback) |
Get tunnel time series drc stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/drc/{pathv1}?{query} |
Yes |
| statsTimeseriesDscp(startTime, endTime, granularity = 'minute', groupPk, trafficType = 'optimized_traffic', dscp, limit, format = 'CSV', ip, latest, callback) |
Get dscp time series stats data filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/dscp?{query} |
Yes |
| postStatsTimeseriesDscp(applianceIDs, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', dscp, limit, format = 'CSV', ip, latest, callback) |
Get dscp time series stats data filter by certain query parameters and certain appliance IDs. |
{base_path}/{version}/stats/timeseries/dscp?{query} |
Yes |
| getStatsTimeseriesDscpNePk(nePk, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', dscp, limit, format = 'CSV', ip, latest, callback) |
Get dscp time series stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/dscp/{pathv1}?{query} |
Yes |
| statsTimeseriesFlow(startTime, endTime, granularity = 'minute', groupPk, trafficType = 'optimized_traffic', flowType = 'TCP_ACCELERATED', limit, format = 'CSV', ip, latest, callback) |
Get flow time series stats data filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/flow?{query} |
Yes |
| postStatsTimeseriesFlow(applianceIDs, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', flowType = 'TCP_ACCELERATED', limit, format = 'CSV', ip, latest, callback) |
Get flow time series stats data filter by certain query parameters and certain appliance IDs. |
{base_path}/{version}/stats/timeseries/flow?{query} |
Yes |
| getStatsTimeseriesFlowNePk(nePk, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', flowType = 'TCP_ACCELERATED', limit, format = 'CSV', ip, latest, callback) |
Get flow time series stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/flow/{pathv1}?{query} |
Yes |
| interfaceTimeseriesStats(nePk, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', interfaceName, limit, callback) |
Get interface time series stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/interface/{pathv1}?{query} |
Yes |
| interfaceOverlayTransportTimeseriesStats(nePk, startTime, endTime, granularity = 'minute', overlay, callback) |
Get interface overlay transport time series stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/interfaceOverlay/{pathv1}?{query} |
Yes |
| statsTimeseriesInternalDrops(nePk, startTime, endTime, granularity = 'minute', callback) |
Get internalDrops time series stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/internalDrops/{pathv1}?{query} |
Yes |
| statsTimeseriesTunnel(startTime, endTime, key, callback) |
Get tunnel time series stats data filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/metrics?{query} |
Yes |
| mOSTimeSeriesStats(nePk, startTime, endTime, granularity = 'minute', tunnel, limit, callback) |
Get Mean Opinion Score time series stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/mos/{pathv1}?{query} |
Yes |
| securityPolicyTimeSeriesStats(nePk, startTime, endTime, granularity = 'minute', fromZone, toZone, callback) |
Get security policy time series stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/securityPolicy/{pathv1}?{query} |
Yes |
| shaperTimeseriesStats(groupPk, startTime, endTime, granularity = 'minute', trafficClass, direction, ip, format = 'CSV', callback) |
Get Shaper time series stats data filter by certain query parameters and certain appliance IDs. |
{base_path}/{version}/stats/timeseries/shaper?{query} |
Yes |
| postStatsTimeseriesShaper(applianceIDs, startTime, endTime, granularity = 'minute', trafficClass, direction, ip, format = 'CSV', callback) |
Get Shaper time series stats data filter by certain query parameters and certain appliance IDs. |
{base_path}/{version}/stats/timeseries/shaper?{query} |
Yes |
| statsTimeseriesTrafficClass(startTime, endTime, granularity = 'minute', groupPk, trafficType = 'optimized_traffic', trafficClass, limit, format = 'CSV', ip, latest, callback) |
Get traffic class time series stats data filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/trafficClass?{query} |
Yes |
| postStatsTimeseriesTrafficClass(applianceIDs, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', trafficClass, limit, format = 'CSV', ip, latest, callback) |
Get traffic class time series stats data filter by certain query parameters and certain appliance IDs. |
{base_path}/{version}/stats/timeseries/trafficClass?{query} |
Yes |
| getStatsTimeseriesTrafficClassNePk(nePk, startTime, endTime, granularity = 'minute', trafficType = 'optimized_traffic', trafficClass, limit, format = 'CSV', ip, latest, callback) |
Get traffic class time series stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/trafficClass/{pathv1}?{query} |
Yes |
| getStatsTimeseriesTunnel(startTime, endTime, granularity = 'minute', groupPk, limit, format = 'CSV', ip, latest, callback) |
Get tunnel time series stats data filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/tunnel?{query} |
Yes |
| postStatsTimeseriesTunnel(applianceIDs, startTime, endTime, granularity = 'minute', limit, format = 'CSV', ip, latest, callback) |
Get tunnel time series stats data filter by certain query parameters and certain appliance IDs. |
{base_path}/{version}/stats/timeseries/tunnel?{query} |
Yes |
| getStatsTimeseriesTunnelNePk(nePk, startTime, endTime, granularity = 'minute', tunnelName, limit, format = 'CSV', ip, latest, callback) |
Get tunnel time series stats data of a single appliance filter by certain query parameters. |
{base_path}/{version}/stats/timeseries/tunnel/{pathv1}?{query} |
Yes |
| confSubnets(neId, operation, callback) |
Configure an appliance's subnets. |
{base_path}/{version}/subnets/configured/{pathv1}?{query} |
Yes |
| getSubnetsForDiscoveredAppliance(discoveredId, callback) |
Get a discovered appliance's subnets information. |
{base_path}/{version}/subnets/forDiscovered/{pathv1}?{query} |
Yes |
| setSubnetSharingOptions(neId, subnetsSystemJson, callback) |
Configure appliance's subnet sharing options |
{base_path}/{version}/subnets/setSubnetSharingOptions/{pathv1}?{query} |
Yes |
| getSubnets(getCachedData, neId, subnet, callback) |
Get an appliance's subnets information. |
{base_path}/{version}/subnets/{pathv1}/{pathv2}?{query} |
Yes |
| appSystemDeployInfo(neId, cached, callback) |
Get Appliance System Deployment Information |
{base_path}/{version}/systemInfo/system/{pathv1}?{query} |
Yes |
| discoveredAppSystemDeployInfo(discoveredId, callback) |
Discovered Appliance System Deployment Information |
{base_path}/{version}/systemInfo/systemForDiscovered/{pathv1}?{query} |
Yes |
| appSystemStateInfo(neId, cached, callback) |
Get Appliance System State Information |
{base_path}/{version}/systemInfo/{pathv1}?{query} |
Yes |
| getTunnelTca(neId, cached, callback) |
Get tunnel threshold crossing alerts |
{base_path}/{version}/tca/tunnel/{pathv1}?{query} |
Yes |
| getSystemTca(neId, cached, callback) |
Get system threshold crossing alerts |
{base_path}/{version}/tca/{pathv1}?{query} |
Yes |
| tcpdumpRun(postRunConfig, callback) |
POST operation to start the packet capture process. |
{base_path}/{version}/tcpdump/run/?{query} |
Yes |
| tcpdumpStatus(neId, callback) |
GET operation to show current packet capture process status. |
{base_path}/{version}/tcpdump/status/{pathv1}?{query} |
Yes |
| getTcpdumpTcpdumpStatus(callback) |
Get the primary keys of all running tcp dumps. |
{base_path}/{version}/tcpdump/tcpdumpStatus?{query} |
Yes |
| associationAll(callback) |
Returns the complete association map of appliances to template groups |
{base_path}/{version}/template/applianceAssociation/?{query} |
Yes |
| associationOne(nePk, callback) |
Returns the association map of template groups for a single appliance |
{base_path}/{version}/template/applianceAssociation/{pathv1}?{query} |
Yes |
| associationOnePost(body, nePk, callback) |
Associates the templates with a specific appliance. The array posted is the complete association for that appliance. |
{base_path}/{version}/template/applianceAssociation/{pathv1}?{query} |
Yes |
| template(nePk, callback) |
Returns the list of template groups applied to the appliance |
{base_path}/{version}/template/history/groupList/{pathv1}?{query} |
Yes |
| getTemplateHistoryNePk(nePk, latestOnly, callback) |
Returns history of applied templates by nePk |
{base_path}/{version}/template/history/{pathv1}?{query} |
Yes |
| postTemplateTemplateCreate(body, callback) |
Creates a new template group |
{base_path}/{version}/template/templateCreate?{query} |
Yes |
| getTemplateTemplateGroups(callback) |
Returns template configurations for all template groups |
{base_path}/{version}/template/templateGroups?{query} |
Yes |
| deleteTemplateTemplateGroupsTemplateGroup(templateGroup, callback) |
Deletes a template group |
{base_path}/{version}/template/templateGroups/{pathv1}?{query} |
Yes |
| getTemplateTemplateGroupsTemplateGroup(templateGroup, callback) |
Returns template configurations for the specified template group only |
{base_path}/{version}/template/templateGroups/{pathv1}?{query} |
Yes |
| postTemplateTemplateGroupsTemplateGroup(templateGroup, body, callback) |
Creates a new template group from an existing one or updates the configuration of the requested template group |
{base_path}/{version}/template/templateGroups/{pathv1}?{query} |
Yes |
| groupPrioGet(callback) |
Returns the order that template groups will be applied in |
{base_path}/{version}/template/templateGroupsPriorities?{query} |
Yes |
| groupPrioPost(body, callback) |
Post the order that template groups should be applied in, groups not listed are not in a deterministic order |
{base_path}/{version}/template/templateGroupsPriorities?{query} |
Yes |
| getTemplateTemplateSelectionTemplateGroup(templateGroup, callback) |
Returns the selected templates in the template group |
{base_path}/{version}/template/templateSelection/{pathv1}?{query} |
Yes |
| postTemplateTemplateSelectionTemplateGroup(templateGroup, body, callback) |
Selects the provided templates in the request body |
{base_path}/{version}/template/templateSelection/{pathv1}?{query} |
Yes |
| rdPartyLicenses(format, callback) |
Gets all third party licenses information |
{base_path}/{version}/thirdPartyLicenses?{query} |
Yes |
| zscalerConfigurationGet(callback) |
Returns Zscaler configuration, including tunnel setting, selected interface label order |
{base_path}/{version}/thirdPartyServices/zscaler/configuration?{query} |
Yes |
| zscalerConfigurationPost(configuration, callback) |
Update Returns Zscaler configuration, including tunnel setting, selected interface label order |
{base_path}/{version}/thirdPartyServices/zscaler/configuration?{query} |
Yes |
| zscalerConnectivityGet(callback) |
Returns Zscaler connectivity status |
{base_path}/{version}/thirdPartyServices/zscaler/connectivity?{query} |
Yes |
| zscalerDefaultTunnelSettingGet(callback) |
Returns recommend tunnel setting for Zscaler |
{base_path}/{version}/thirdPartyServices/zscaler/defaultTunnelSetting?{query} |
Yes |
| zscalerPauseOrchestrationGet(callback) |
Returns Pause Zscaler Orchestration configuration |
{base_path}/{version}/thirdPartyServices/zscaler/pauseOrchestration?{query} |
Yes |
| zscalerPauseOrchestrationPost(zscalerPauseObj, callback) |
update pause Zscaler Orchestration configuration |
{base_path}/{version}/thirdPartyServices/zscaler/pauseOrchestration?{query} |
Yes |
| zscalerRemoteEndpointExceptionGet(callback) |
Returns all user configured ZEN Override data |
{base_path}/{version}/thirdPartyServices/zscaler/remoteEndpointException?{query} |
Yes |
| zscalerSubscriptionDelete(callback) |
Delete Subscription |
{base_path}/{version}/thirdPartyServices/zscaler/subscription?{query} |
Yes |
| zscalerSubscriptionGet(callback) |
Returns Zscaler subscription |
{base_path}/{version}/thirdPartyServices/zscaler/subscription?{query} |
Yes |
| zscalerSubscriptionPost(subscription, callback) |
Add/Update Subscription |
{base_path}/{version}/thirdPartyServices/zscaler/subscription?{query} |
Yes |
| zscalerVpnLocationExceptionPost(applianceList, callback) |
Get all VPN, Location, discovered and configured ZEN override data for one or more appliances |
{base_path}/{version}/thirdPartyServices/zscaler/vpnLocationEndpointExceptionSetting?{query} |
Yes |
| getBondedTunnelsConfigurationAndStates(neIds, overlayId, callback) |
Deprecated |
{base_path}/{version}/tunnels/bonded?{query} |
Yes |
| getBondedTunnelsStates(neIds, callback) |
Get the current list of tunnels state |
{base_path}/{version}/tunnels/bonded/state?{query} |
Yes |
| getTunnelsConfigurationAndStates(ids, state, callback) |
Deprecated. Get the current list of tunnels configuration and their state information |
{base_path}/{version}/tunnels/physical?{query} |
Yes |
| getTunnelsStates(neIds, state, callback) |
Get the current list of tunnels state |
{base_path}/{version}/tunnels/physical/state?{query} |
Yes |
| initiateTraceroute(id, nePk, callback) |
Initiate a traceroute on a tunnel |
{base_path}/{version}/tunnels/physical/traceroute/{pathv1}?{query} |
Yes |
| tracerouteState(id, nePk, callback) |
Get traceroute state for a tunnel |
{base_path}/{version}/tunnels/physical/tracerouteState/{pathv1}?{query} |
Yes |
| getThirdPartyTunnelsConfigurationAndStates(neIds, state, callback) |
Deprecated. Get the current list of tunnels configuration and their state information |
{base_path}/{version}/tunnels/thirdParty?{query} |
Yes |
| getThirdPartyTunnelsStates(neIds, state, callback) |
Get the current list of tunnels state |
{base_path}/{version}/tunnels/thirdParty/state?{query} |
Yes |
| tunnelsCount(metaData, callback) |
Search total tunnel count, all appliances |
{base_path}/{version}/tunnels2?{query} |
Yes |
| searchAllBondedTunnels(limit, matchingAlias, overlayId, state, callback) |
Get bonded tunnels for all appliances |
{base_path}/{version}/tunnels2/bonded?{query} |
Yes |
| searchBondedTunnelsForAppliance(nePk, limit, matchingAlias, overlayId, state, callback) |
Get bonded tunnels for one appliance |
{base_path}/{version}/tunnels2/bonded/{pathv1}?{query} |
Yes |
| getOneBondedTunnel(bondedTunnelId, nePk, callback) |
Get a specific bonded tunnel for one appliance |
{base_path}/{version}/tunnels2/bonded/{pathv1}/{pathv2}?{query} |
Yes |
| getBondedTunnelsWithPhysicalTunnels(nePk, physicalTunnelId, state, callback) |
Get bonded tunnels a physical tunnel belongs to |
{base_path}/{version}/tunnels2/bondedTunnelsWithPhysicalTunnel/{pathv1}/{pathv2}?{query} |
Yes |
| getTunnelsBetweenAppliances(ids, limit, matchingAlias, overlayId, state, callback) |
Get all tunnels between appliances |
{base_path}/{version}/tunnels2/getTunnelsBetweenAppliances?{query} |
Yes |
| searchAllPassThroughTunnels(limit, matchingAlias, matchingService, state, callback) |
Search pass through tunnels |
{base_path}/{version}/tunnels2/passThrough?{query} |
Yes |
| searchAppliancePassthroughTunnels(nePk, limit, matchingAlias, matchingService, state, callback) |
Search pass through tunnels for one appliance |
{base_path}/{version}/tunnels2/passThrough/{pathv1}?{query} |
Yes |
| getPassThroughTunnel(nePk, passThroughTunnelId, callback) |
Get pass through tunnel |
{base_path}/{version}/tunnels2/passThrough/{pathv1}/{pathv2}?{query} |
Yes |
| searchAllPhysicalTunnels(limit, matchingAlias, state, callback) |
Search physical tunnels, all appliances |
{base_path}/{version}/tunnels2/physical?{query} |
Yes |
| getTunnels2PhysicalNePk(nePk, limit, matchingAlias, state, callback) |
Search physical tunnels for one appliance |
{base_path}/{version}/tunnels2/physical/{pathv1}?{query} |
Yes |
| getOnePhysicalTunnel(nePk, tunnelId, callback) |
Get physical tunnel |
{base_path}/{version}/tunnels2/physical/{pathv1}/{pathv2}?{query} |
Yes |
| tunnelsDeploymentInfo(callback) |
Get deployment information for appliances managed by the Orchestrator. |
{base_path}/{version}/tunnelsConfiguration/deployment?{query} |
Yes |
| tunnelsOverlayInfo(callback) |
Get the tunnels in each overlay |
{base_path}/{version}/tunnelsConfiguration/overlayInfo?{query} |
Yes |
| passThroughTunnelsInfo(callback) |
Get all pass through tunnels from all appliances |
{base_path}/{version}/tunnelsConfiguration/passThroughTunnelsInfo?{query} |
Yes |
| uiUsageStats(uiName, callback) |
Add usage count for one UI feature |
{base_path}/{version}/uiUsageStats/{pathv1}?{query} |
Yes |
| upgradeAppliances(applianceUpgradeEntry, callback) |
Upgrade appliances with option |
{base_path}/{version}/upgradeAppliances?{query} |
Yes |
| getUserAccount(neId, cached, callback) |
Gets all user details and sessions of appliance |
{base_path}/{version}/userAccount/{pathv1}?{query} |
Yes |
| users(callback) |
Returns all the users in the system |
{base_path}/{version}/users?{query} |
Yes |
| forgotPassword(forgotPasswordBody, callback) |
Forgot password |
{base_path}/{version}/users/forgotPassword?{query} |
Yes |
| newTfaKey(callback) |
Returns a barcode to scan with an authentication application to set up app based two factor authentication for your account |
{base_path}/{version}/users/newTfaKey?{query} |
Yes |
| resetPassword(resetPasswordBody, callback) |
Resets user password |
{base_path}/{version}/users/resetPassword?{query} |
Yes |
| postUsersNewUser(newUser, saveUpdateUserBody, callback) |
Creates a new user or updates it. 'Status: Active/Inactive. Role: Admin Manager/Network Monitor' |
{base_path}/{version}/users/{pathv1}?{query} |
Yes |
| deleteUsersUserIdUserName(userId, userName, callback) |
Deletes the specified user |
{base_path}/{version}/users/{pathv1}/{pathv2}?{query} |
Yes |
| getUsersUserName(userName, callback) |
Gets user by username |
{base_path}/{version}/users/{pathv1}?{query} |
Yes |
| postUsersUsernamePassword(username, changePasswordBody, callback) |
Changes user password |
{base_path}/{version}/users/{pathv1}/password?{query} |
Yes |
| loopbackGet(neId, cached, callback) |
Get loopback interface configuration on the appliance |
{base_path}/{version}/virtualif/loopback/{pathv1}?{query} |
Yes |
| vtiGet(neId, cached, callback) |
Get VTI interface configuration on the appliance |
{base_path}/{version}/virtualif/vti/{pathv1}?{query} |
Yes |
| vrrpGet(neId, cached, callback) |
Get a list of VRRP instances configured on the appliance |
{base_path}/{version}/vrrp/{pathv1}?{query} |
Yes |
| vXOAImagesGet(callback) |
Get VXOA images |
{base_path}/{version}/vxoaImages?{query} |
Yes |
| vXOAImagesDelete(imageFile, callback) |
Delete VXOA image |
{base_path}/{version}/vxoaImages/{pathv1}?{query} |
Yes |
| wccpConfigGroup(neId, cached, callback) |
Get WCCP service groups settings for the appliance. |
{base_path}/{version}/wccp/config/group/{pathv1}?{query} |
Yes |
| wccpConfigSystem(neId, cached, callback) |
Get WCCP system settings for the appliance |
{base_path}/{version}/wccp/config/system/{pathv1}?{query} |
Yes |
| wccpState(neId, cached, callback) |
Get WCCP state |
{base_path}/{version}/wccp/state/{pathv1}?{query} |
Yes |
| zonesGet(callback) |
Returns all Zones defined in Orchestrator |
{base_path}/{version}/zones?{query} |
Yes |
| zonesPost(zones, deleteDependencies, callback) |
Add/Edit Zones |
{base_path}/{version}/zones?{query} |
Yes |
| nextIdGet(callback) |
Returns Next Id that should be assigned to a new Zone |
{base_path}/{version}/zones/nextId?{query} |
Yes |
| nextIdPost(nextIdPost, callback) |
Update Next Id |
{base_path}/{version}/zones/nextId?{query} |
Yes |