Pre 9.3 Orchestrator API Endpoints

Endpoint definitions for HPE Aruba Networking EdgeConnect Orchestrator REST APIs changed in Orchestrator 9.3.0, which required users to update endpoint definitions in their Orchestrator REST API scripts. To reduce the magnitude of change required, Orchestrator 9.3.1 has introduced the capability to enable RBAC Legacy API Support and continue using your existing Orchestrator REST API scripts for a specific list of frequently used commands.

How do I enable the pre-9.3 (Interop) API support?

To enable Interop API support on self-hosted Orchestrators, navigate to Orchestrator > Software & Setup > Setup > Advanced Properties and set the enableLegacyApisSupport property value to True.
To enable Interop API support on Orchestrator as a Service (OaaS) changing requires a support case with TAC.

NOTE: It is recommended that you restart the Orchestrator during a maintenance window.

Orchestrator Advance Properties: enableLegacyApisSupport — Orchestrator Advanced Properties: enableLegacyApisSupport

Orchestrator Release	Enable Legacy API support (True/False)	APIs Supported (Pre / Post 9.3.0)	RBAC supported?
9.2 and lower	N/A	Pre 9.3.0	NO
9.3.0	N/A	Post 9.3.0	YES
9.3.1	false	Post 9.3.0	YES
9.3.1	true	Post 9.3.0 + Interop Orchestrator 9.3 API list	YES

Will the RBAC filter still be applied to the Interop Orchestrator REST API endpoints?

Starting with 9.3.0, RBAC is applied to all API endpoints
Starting with 9.3.1, RBAC is applied to all API endpoint; includes post 9.3 API and Interop (Pre-9.3) Orchestrator API endpoints.

What if the API endpoint I am using in my pre-9.3 code is not in the list below?

A new API endpoint (rbac/legacyApi) has been introduced to add a new Interop API pattern that is not already in the Interop list (see Pre 9.3 API Endpoints). You must test and verify that the new pattern in the database does not create issues.

NOTE: REST request performance will be impacted due to increased latency in request filtering and routing of Interop REST APIs. It is recommended that all scripts be modified to adapt to the new Orchestrator 9.3 REST API endpoints. For a complete list of the new Orchestrator 9.3 REST API endpoints go here.

Interop Orchestrator 9.3 API List

The table below is a list of Pre 9.3 APIs which are now available in 9.3.1 when the Advance setting enableLegacyApisSupport is set to True.

Tag	Method	Pre 9.3	9.3.1 [enableLegacyApisSuport=false]	9.3.1 [enableLegacyApisSuport=true]
appliance	GET	/appliance/{nePk}/{url}	/appliance?{nePk}&url={url}	/appliance/{nePk}/{url}
appliance	POST	/appliance/{nePk}/{url}	appliance?{nePk}&url={url}	/appliance/{nePk}/{url}
appliance	DELETE	/appliance/{nePk}/{url}	/appliance?{nePk}&url={url}	/appliance/{nePk}/{url}
appliance	DELETE	/appliance/backup/{backupFilePk}	/appliance/backup?backupFilePk={backupFilePk}	/appliance/backup/{backupFilePk}
appliance	POST	/appliance/backup requestBody={neList: [0.NE]}	/appliance/backup requestBody={nePks: [0.NE]}	/appliance/backup requestBody={neList: [0.NE]}
acls	GET	/acls/{nePk}	/acls?nePk={nePk}	/acls/{nePk}
alarm	GET	/alarm/summary/{type=gms\|appliance}	/alarm/summary?type={gms\|appliance}	/alarm/summary/{type=gms\|appliance}
alarm	GET	/alarm/count/appliance/{nePk}	/alarm/count/appliance?nePk={nePk}	/alarm/count/appliance/{nePk}
alarm	POST	/alarm/appliance/requestBody={ids:[0.NE]}	/alarm/appliance?requestBody={nePk}[0.NE]]	/alarm/appliance/requestBody={ids:[0.NE]}
applianceExtraInfo	GET	/appliance/extraInfo/{nePk}	/appliance/extraInfo?nePk={nePk}	/appliance/extraInfo/{nePk}
bgp	GET	/bgp/config/neighbor/{nePk}	/bgp/config/neighbor?nePk={nePk}	/bgp/config/neighbor/{nePk}
bgp	GET	/bgp/state/{nePk}	/bgp/state?nePk={nePk}	/bgp/state/{nePk}
deployment	GET	/deployment/{nePk}	/deployment?nePk={nePk}	/deployment/{nePk}
interfaceState	GET	/interfaceState/{nePk}	/interfaceState?nePk={nePk}	/interfaceState/{nePk}
reachability	GET	/reachability/appliance/{nePk}	/reachability/appliance?nePk={nePk}	/reachability/appliance/{nePk}
reachability	GET	/reachability/gms/{nePk}	/reachability/gms?nePk={nePk}	/reachability/gms/{nePk}
subnets	GET	/subnets/{cached}/{nePk}	/subnets?cached={cached}&nePk={nePk}	/subnets/{cached}/{nePk}
subnets	GET	/subnets/all/{nePk}	/subnets?nePk={nePk}	/subnets/all/{nePk}
appSystemStateInfo	GET	/systemInfo/{nePk}	/systemInfo?nePk={nePk}	/systemInfo/{nePk}
appSystemDeployInfo	GET	/systemInfo/system/{nePk}	/systemInfo/system?nePk={nePk}	/systemInfo/system/{nePk}
bondedTunnelsConfiguration	GET	/tunnels2/bonded/{nePk}	/tunnels2/bonded?nePk={nePk}	/tunnels2/bonded/{nePk}
thirdPartyTunnelsConfiguration	GET	/tunnels2/passThrough/{nePk}	/tunnels2/passThrough?nePk={nePk}	/tunnels2/passThrough/{nePk}
tunnelsConfiguration	GET	/tunnels2/physical/{nePk}	/tunnels2/physical?nePk={nePk}	/tunnels2/physical/{nePk}
vrrp	GET	/vrrp/{nePk}	/vrrp?nePk={nePk}	/vrrp/{nePk}
deployment	POST	/deployment/validate/{nePk}	/deployment/validate?nePk={nePk}	/deployment/validate/{nePk}
grnode	POST	/grNode/forNePk/{nePk}	/grNode/forNePk?nePk={nePk}	/grNode/forNePk/{nePk}
flow	GET	/flow/{nePk}	/flow?ne=Pk={nePk}	/flow/{nePk}
nat	GET	/nat/{nePk}	/nat?nePk={nePk}	/nat/{nePk}
securityMaps	GET	/securityMaps/nePk={nePk}?cached={cached}	/securityMaps?{nePk}cached={true/false}	/securityMaps/{nePk}?cached={cached}
timeseriesStats	GET	/stats/timeseries/boost/{nePk}?queryParams....	/stats/timeseries/boost?nePk={nePk}&queryParams....	/stats/timeseries/boost/{nePk}?queryParams....
timeseriesStats	GET	/stats/timeseries/tunnel/{nePk}?queryParams....	/stats/timeseries/tunnel?nePk={nePk}&queryParams....	/stats/timeseries/tunnel/{nePk}?queryParams....
apiKey	GET	/apiKey/{name}	/apiKey?name={name}	/apiKey/{name}
applicationDefinition	GET	/applicationDefinition/compoundClassification	/applicationDefinition?base=compoundClassification	/applicationDefinition/compoundClassification
applicationDefinition	GET	/applicationDefinition/dnsClassification	/applicationDefinition?base=dnsClassification	/applicationDefinition/dnsClassification
applicationDefinition	GET	/applicationDefinition/ipIntelligenceClassification	/applicationDefinition?base=ipIntelligenceClassification	/applicationDefinition/ipIntelligenceClassification
applicationDefinition	GET	/applicationDefinition/portProtocolClassification	/applicationDefinition?base=portProtocolClassification	/applicationDefinition/portProtocolClassification
applicationDefinition	POST	/applicationDefinition/compoundClassification/{id}	/applicationDefinition/compoundClassification?id={id}	/applicationDefinition/compoundClassification/{id}
applicationDefinition	POST	/applicationDefinition/ipIntelligenceClassification/{ipStart}/{ipEnd}	/applicationDefinition/ipIntelligenceClassification?ipStart={ipStart}&ipEnd={ipEnd}	/applicationDefinition/ipIntelligenceClassification/{ipStart}/{ipEnd}
applicationDefinition	POST	/applicationDefinition/dnsClassification/{domain}	/applicationDefinition/dnsClassification?domain={domain}	/applicationDefinition/dnsClassification/{domain}
applicationDefinition	DELETE	/applicationDefinition/dnsClassification/{domain}	/applicationDefinition/dnsClassification?domain={domain}	/applicationDefinition/dnsClassification/{domain}
applicationDefinition	POST	/applicationDefinition/portProtocolClassification/{port}/{protocol}	/applicationDefinition/portProtocolClassification?port={port}&protocol={protocol}	/applicationDefinition/portProtocolClassification/{port}/{protocol}
remoteLogReceiver	DELETE	/remoteLogReceiver/{receiverId}	/remoteLogReceiver?receiverId={receiverId}	/remoteLogReceiver/{receiverId}
rbacAssignmet	DELETE	/rbac/assignment/{username}	/rbac/assignment?username={username}	/rbac/assignment/{username}
user	GET	/users/{userId}	/users?userId={userId}	/users/{userId}
user	POST	/users/{newUser=true\|false}	/users?newUser={true\|false}	/users/{newUser=true\|false}
user	DELETE	/users/{userId}/{userName}	/users?userId={userId}&userName={userName}	/users/{userId}/{userName}
appliancePreconfig	POST	/appliance/preconfiguration/{preconfigId}	/appliance/preconfiguration?preconfigId={preconfigId}	/appliance/preconfiguration/{preconfigId}
appliancePreconfig	POST	/appliance/preconfiguration/{preconfigId}/apply/{nePk}	/appliance/preconfiguration/apply?preconfigId={preconfigId}&nePk={nePk}	/appliance/preconfiguration/{preconfigId}/apply/{nePk}
appliancePreconfig	POST	/appliance/preconfiguration/{preconfigId}/apply/discovered/{discoveredId}	/appliance/preconfiguration/apply/discovered?preconfigId={preconfigId}&discoveredId={discoveredId}	/appliance/preconfiguration/{preconfigId}/apply/discovered/{discoveredId}
ipObjects	GET	/ipObjects/addressGroup/{name}	/ipObjects/addressGroup?name={name}	/ipObjects/addressGroup/{name}
ipObjects	GET	/ipObjects/serviceGroup/{name}	/ipObjects/serviceGroup?name={name}	/ipObjects/serviceGroup/{name}
ipObjects	DELETE	/ipObjects/addressGroup/{name}	/ipObjects/addressGroup?name={name}	/ipObjects/addressGroup/{name}
ipObjects	DELETE	/ipObjects/serviceGroup/{name}	/ipObjects/serviceGroup?name={name}	/ipObjects/serviceGroup/{name}
template	GET	/template/templateGroups	/template/templateGroups?templateGroup={templateGroup}	/template/templateGroups/{templateGroup}
template	POST	/template/templateGroups/{templateGroup}	/template/templateGroups?templateGroup={templateGroup}	/template/templateGroups/{templateGroup}
template	DELETE	/template/templateGroups/{templateGroup}	/template/templateGroups?templateGroup={templateGroup}	/template/templateGroups/{templateGroup}