# Documentation for AdvantEDGE Sandbox Controller REST API

<a name="documentation-for-api-endpoints"></a>
## Documentation for API Endpoints

All URIs are relative to *http://localhost/sandboxname/sandbox-ctrl/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ActiveScenarioApi* | [**activateScenario**](Apis/ActiveScenarioApi.md#activatescenario) | **POST** /active/{name} | Deploy a scenario
*ActiveScenarioApi* | [**getActiveNodeServiceMaps**](Apis/ActiveScenarioApi.md#getactivenodeservicemaps) | **GET** /active/serviceMaps | Get deployed scenario's port mapping
*ActiveScenarioApi* | [**getActiveScenario**](Apis/ActiveScenarioApi.md#getactivescenario) | **GET** /active | Get the deployed scenario
*ActiveScenarioApi* | [**getActiveScenarioDomain**](Apis/ActiveScenarioApi.md#getactivescenariodomain) | **GET** /active/domains | Get domain elements from the deployed scenario
*ActiveScenarioApi* | [**getActiveScenarioNetworkLocation**](Apis/ActiveScenarioApi.md#getactivescenarionetworklocation) | **GET** /active/networkLocations | Get network location elements from the deployed scenario
*ActiveScenarioApi* | [**getActiveScenarioPhysicalLocation**](Apis/ActiveScenarioApi.md#getactivescenariophysicallocation) | **GET** /active/physicalLocations | Get physical location elements from the deployed scenario
*ActiveScenarioApi* | [**getActiveScenarioProcess**](Apis/ActiveScenarioApi.md#getactivescenarioprocess) | **GET** /active/processes | Get process elements from the deployed scenario
*ActiveScenarioApi* | [**getActiveScenarioZone**](Apis/ActiveScenarioApi.md#getactivescenariozone) | **GET** /active/zones | Get zone elements from the deployed scenario
*ActiveScenarioApi* | [**terminateScenario**](Apis/ActiveScenarioApi.md#terminatescenario) | **DELETE** /active | Terminate the deployed scenario
*ApplicationsApi* | [**applicationsAppInstanceIdDELETE**](Apis/ApplicationsApi.md#applicationsappinstanceiddelete) | **DELETE** /applications/{appInstanceId} | This method deletes a mec application resource.
*ApplicationsApi* | [**applicationsAppInstanceIdGET**](Apis/ApplicationsApi.md#applicationsappinstanceidget) | **GET** /applications/{appInstanceId} | This method retrieves information about a mec application resource.
*ApplicationsApi* | [**applicationsAppInstanceIdPUT**](Apis/ApplicationsApi.md#applicationsappinstanceidput) | **PUT** /applications/{appInstanceId} | This method updates the information about a mec application resource.
*ApplicationsApi* | [**applicationsGET**](Apis/ApplicationsApi.md#applicationsget) | **GET** /applications | This method retrieves information about a list of mec application resources.
*ApplicationsApi* | [**applicationsPOST**](Apis/ApplicationsApi.md#applicationspost) | **POST** /applications | This method is used to create a mec application resource.
*ConnectivityApi* | [**createPduSession**](Apis/ConnectivityApi.md#createpdusession) | **POST** /connectivity/pdu-session/{ueName}/{pduSessionId} | Create a PDU Session
*ConnectivityApi* | [**getPduSessionList**](Apis/ConnectivityApi.md#getpdusessionlist) | **GET** /connectivity/pdu-session | Get list of PDU Sessions
*ConnectivityApi* | [**terminatePduSession**](Apis/ConnectivityApi.md#terminatepdusession) | **DELETE** /connectivity/pdu-session/{ueName}/{pduSessionId} | Terminate a PDU Session
*EventReplayApi* | [**createReplayFile**](Apis/EventReplayApi.md#createreplayfile) | **POST** /replay/{name} | Add a replay file
*EventReplayApi* | [**createReplayFileFromScenarioExec**](Apis/EventReplayApi.md#createreplayfilefromscenarioexec) | **POST** /replay/{name}/generate | Generate a replay file from Active Scenario events
*EventReplayApi* | [**deleteReplayFile**](Apis/EventReplayApi.md#deletereplayfile) | **DELETE** /replay/{name} | Delete a replay file
*EventReplayApi* | [**deleteReplayFileList**](Apis/EventReplayApi.md#deletereplayfilelist) | **DELETE** /replay | Delete all replay files
*EventReplayApi* | [**getReplayFile**](Apis/EventReplayApi.md#getreplayfile) | **GET** /replay/{name} | Get a specific replay file
*EventReplayApi* | [**getReplayFileList**](Apis/EventReplayApi.md#getreplayfilelist) | **GET** /replay | Get all replay file names
*EventReplayApi* | [**getReplayStatus**](Apis/EventReplayApi.md#getreplaystatus) | **GET** /replaystatus | Get status of replay manager
*EventReplayApi* | [**loopReplay**](Apis/EventReplayApi.md#loopreplay) | **POST** /replay/{name}/loop | Loop-Execute a replay file present in the platform store
*EventReplayApi* | [**playReplayFile**](Apis/EventReplayApi.md#playreplayfile) | **POST** /replay/{name}/play | Execute a replay file present in the platform store
*EventReplayApi* | [**stopReplayFile**](Apis/EventReplayApi.md#stopreplayfile) | **POST** /replay/{name}/stop | Stop execution of a replay file
*EventsApi* | [**sendEvent**](Apis/EventsApi.md#sendevent) | **POST** /events/{type} | Send events to the deployed scenario
*ServicesApi* | [**servicesGET**](Apis/ServicesApi.md#servicesget) | **GET** /services | This method retrieves registered MEC application services.


<a name="documentation-for-models"></a>
## Documentation for Models

 - [ActivationInfo](./Models/ActivationInfo.md)
 - [ApplicationInfo](./Models/ApplicationInfo.md)
 - [CellularDomainConfig](./Models/CellularDomainConfig.md)
 - [CellularPoaConfig](./Models/CellularPoaConfig.md)
 - [ConnectivityConfig](./Models/ConnectivityConfig.md)
 - [CpuConfig](./Models/CpuConfig.md)
 - [D2dConfig](./Models/D2dConfig.md)
 - [DNConfig](./Models/DNConfig.md)
 - [Deployment](./Models/Deployment.md)
 - [Domain](./Models/Domain.md)
 - [Domains](./Models/Domains.md)
 - [EgressService](./Models/EgressService.md)
 - [Event](./Models/Event.md)
 - [EventMobility](./Models/EventMobility.md)
 - [EventNetworkCharacteristicsUpdate](./Models/EventNetworkCharacteristicsUpdate.md)
 - [EventPduSession](./Models/EventPduSession.md)
 - [EventPoasInRange](./Models/EventPoasInRange.md)
 - [EventScenarioUpdate](./Models/EventScenarioUpdate.md)
 - [ExternalConfig](./Models/ExternalConfig.md)
 - [GeoData](./Models/GeoData.md)
 - [GpuConfig](./Models/GpuConfig.md)
 - [IngressService](./Models/IngressService.md)
 - [LineString](./Models/LineString.md)
 - [MemoryConfig](./Models/MemoryConfig.md)
 - [NetworkCharacteristics](./Models/NetworkCharacteristics.md)
 - [NetworkLocation](./Models/NetworkLocation.md)
 - [NetworkLocations](./Models/NetworkLocations.md)
 - [NodeDataUnion](./Models/NodeDataUnion.md)
 - [NodeServiceMaps](./Models/NodeServiceMaps.md)
 - [PDUSession](./Models/PDUSession.md)
 - [PDUSessionInfo](./Models/PDUSessionInfo.md)
 - [PDUSessionList](./Models/PDUSessionList.md)
 - [PhysicalLocation](./Models/PhysicalLocation.md)
 - [PhysicalLocations](./Models/PhysicalLocations.md)
 - [Poa4GConfig](./Models/Poa4GConfig.md)
 - [Poa5GConfig](./Models/Poa5GConfig.md)
 - [PoaWifiConfig](./Models/PoaWifiConfig.md)
 - [Point](./Models/Point.md)
 - [Process](./Models/Process.md)
 - [Processes](./Models/Processes.md)
 - [Replay](./Models/Replay.md)
 - [ReplayEvent](./Models/ReplayEvent.md)
 - [ReplayFileList](./Models/ReplayFileList.md)
 - [ReplayInfo](./Models/ReplayInfo.md)
 - [ReplayStatus](./Models/ReplayStatus.md)
 - [Scenario](./Models/Scenario.md)
 - [ScenarioConfig](./Models/ScenarioConfig.md)
 - [ScenarioNode](./Models/ScenarioNode.md)
 - [ServiceConfig](./Models/ServiceConfig.md)
 - [ServiceInfo](./Models/ServiceInfo.md)
 - [ServicePort](./Models/ServicePort.md)
 - [Zone](./Models/Zone.md)
 - [Zones](./Models/Zones.md)


<a name="documentation-for-authorization"></a>
## Documentation for Authorization

All endpoints do not require authorization.
