REST API for Oracle SD-WAN Edge Release 9.1.1

All REST Endpoints

Authentication

The operations from the Authentication category.

Get a new timestamp: Method: get
Path: http://<SDWAN_TENANT_IP>/restapi/getNewTimestamp
Log in and get a timestamp and a session cookie: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/login
Log out of the appliance: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/logout

Change Management

The operations from the Change Management category.

Activate service on the appliance: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/change_management/activate
Cancel staging operation and return to change preparation state: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/change_management/cancel_staging
Clear out the change preparation area: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/change_management/clear_network_staging
Clear out the contents of the change management inbox: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/change_management/clear_inbox
Get current change management status: Method: get
Path: http://<SDWAN_TENANT_IP>/restapi/change_management/get_status
Ignore incomplete staging file transfers to remote appliances: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/change_management/ignore_incomplete
Migrate current configuration into the inbox to be used in change management: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/change_management/migrate_running_cfg_to_inbox
Prepare to stage contents of inbox used in change management: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/change_management/prepare_to_stage
Retrieve a software or configuration package: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/change_management/get_package_file
Stage contents of inbox used in change management: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/change_management/stage
Upload a registry package to the appliance: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/change_management/upload_file_to_inbox
Verify and validate contents of inbox: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/change_management/verify_inbox

Datetime Settings

The operations from the Datetime Settings category.

Change timezone: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/datetime_settings/timezoneSettings
Get current datetime: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/datetime_settings/getCurrentDateTime
Get the current NTP settings: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/datetime_settings/getNtpSettings
Get the current time zone: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/datetime_settings/getcurrentTimeZone
Save datetime details: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/datetime_settings/dateTimeSettings
Save NTP server details: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/datetime_settings/ntpSettings

Delete Files

The operations from the Delete Files category.

Delete a file: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/delete_files/deleteFile
Get configuration files: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/delete_files/getCfgFiles
Get log files: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/delete_files/getLogFiles

Edge Options

The operations from the Edge Options category.

Delete uploaded Oracle software: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/edge_options/deleteUploadedOracleSoftware
Get package files: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/edge_options/getStatus
Get serviceability attributes: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/edge_options/serviceabilityAttributes
Install Oracle Software: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/edge_options/installOracleSoftware
Switch to console: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/edge_options/switchConsole
Switch to HA mode: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/edge_options/switchHAMode
Update service attributes: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/edge_options/updateServiceAttr
Upload configuration or package: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/edge_options/sdwanOptionsUploadConfgOrPackage
Upload Oracle Software: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/edge_options/sdwanOptionsUploadOracleSoftware

Fetch System Information

The operations from the Fetch System Information category.

Get application and category information: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/application/cumulativeUsage
Get the Ethernet information: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/system/ethernet_info
Get the feature information: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/system/features_info
Get the site information: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/topmenu/siteInfo
Get the site's HD information: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/system/hd_info
Get the system information: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/system/system_info

HTTPS Settings

The operations from the HTTPS Settings category.

Build certificate information: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/https_settings/buildCertificateInfo
Change web console timeout value: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/https_settings/changeWebConsoleTimeOut
Get HTTPS settings information: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/https_settings/getHttpsSettingsInfo
Regenerate an HTTPS certificate: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/https_settings/regenerateHttpsCertificate
Save custom login message: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/https_settings/saveCustomLoginMessage
Save support link info: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/https_settings/saveSupportLinkInfo
Upload custom logo: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/https_settings/uploadCustomLogo
Upload HTTPS certificate file: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/https_settings/uploadHttpsCertFile

IPSec Tunnel

The operations from the IPSec Tunnel category.

IPSec tunnel statistics: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/ip_sec_tunnel

Local Change Management

The operations from the Local Change Management category.

Activate staged packages for the local appliance: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/local_change_management/activate
Get current local change management status: Method: get
Path: http://<SDWAN_TENANT_IP>/restapi/local_change_management/get_status
Upload image: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/local_change_management/upload_package

Manage Appliance

The operations from the Manage Appliance category.

Disable the appliance: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/service/disable
Enable or disable WAN optimization: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/enableDisable/wanOptimization
Enable Oracle service: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/service/enable
Get current Oracle service status: Method: get
Path: http://<SDWAN_TENANT_IP>/restapi/service/get_status
Get the values from drop down: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/enableDisable/fetchEnableDisableDropDown
Purge flows: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/purge_flows/purgeFlows
Reboot the appliance: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/reboot
Restart dynamic routing: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/enableDisable/restartRouting
Restart the appliance: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/restartAppliance

Manage Events

The operations from the Manage Events category.

Adds an event type: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/event_management/events
Clear the alarms: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/event_management/clearAlarms
Get alarm information: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/event_management/alarms
Get event types: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/event_management/getEventTypes
Get the event types: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/event_management/events
Save alarm information: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/event_management/alarms

Manage Network

The operations from the Manage Network category.

Get Oracle Talari MIB: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_network/viewDownloadTalari
Reboot the Talari network: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_network/network_reboot
Restart the network: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_network/network_restart

Manage Users

The operations from the Manage Users category.

Add a user: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/users_Auth/addUser
Authenticate and validate RADIUS settings: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/users_Auth/authenticateRadiusSettings
Authenticate and validate TACACS settings: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/users_Auth/aunthenticateTacacsSettings
Change a user password: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/users_Auth/changeLocalUserPwd
Delete a user: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/users_Auth/deleteSelUser
Delete the workspace of a user: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/users_Auth/deleteUserWorkSpace
Get current RADIUS and TACACS settings: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/users_Auth/getRadiusAndTacacsSettings
Get the list of users: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/users_Auth/getUsers
Save RADIUS settings: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/users_Auth/saveRadiusSettings
Save TACACS settings: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/users_Auth/saveTacacsSettings

OS Partition

The operations from the OS Partition category.

Change partition: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/os_partition/change_partition
Change partition: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/os_partition/change_partition
Clear an uploaded OS Partition image file: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/os_partition/clear_uploaded_image
Clear an uploaded OS partition image file: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/os_partition/clear_uploaded_image
Get OS partition status: Method: get
Path: http://<SDWAN_TENANT_IP>/restapi/os_partition/get_status
Get OS partition status: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/os_partition/get_status
Install uploaded OS image: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/os_partition/install_image
Install uploaded OS image: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/os_partition/install_image
Upload OS image: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/os_partition/upload_image

SDWAN Edge Options

The operations from the SDWAN Edge Options category.

Upload and install a package: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/edge_options/sdwanEdgeUploadAndInstall

Statistics

The operations from the Statistics category.

Get classes and their statuses: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/classes
Get conduits and their statuses: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/conduits
Get Ethernet statistics: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/ethernet
Get local & remote MOS data: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/qoe
Get paths advanced: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/paths_adv
Get paths summary: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/paths_sum
Get routes data for a given routing domain: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/routes
Get routing domains and their routing domain ID identifiers: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/routingDomainAndTableId
Get statistics for the site: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/site
Get the conduit list: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/conduit_names
Get WAN link statistics: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/wan_link
Get worst MOS: Method: get
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/qoe_worst
Save the routes data: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/statistics/routes

Troubleshooting

The operations from the Troubleshooting category.

Create, download or delete diagnostics packages: Method: post
Path: http://<SDWAN_TENANT_IP>/v1/admin/log_diag/diagDumpOperations

upload image

The operations from the upload image category.

Upload OS image: Method: post
Path: http://<SDWAN_TENANT_IP>/restapi/os_partition/upload_image