Skip to content
README.md 2.31 KiB
Newer Older
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
# Documentation for AdvantEDGE Bandwidth Management API

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

All URIs are relative to *https://localhost/sandboxname/bwm/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BwmApi* | [**bandwidthAllocationDELETE**](Apis/BwmApi.md#bandwidthallocationdelete) | **DELETE** /bw_allocations/{allocationId} | Remove a specific bandwidthAllocation
*BwmApi* | [**bandwidthAllocationGET**](Apis/BwmApi.md#bandwidthallocationget) | **GET** /bw_allocations/{allocationId} | Retrieve information about a specific bandwidthAllocation
*BwmApi* | [**bandwidthAllocationListGET**](Apis/BwmApi.md#bandwidthallocationlistget) | **GET** /bw_allocations | Retrieve information about a list of bandwidthAllocation resources
*BwmApi* | [**bandwidthAllocationPATCH**](Apis/BwmApi.md#bandwidthallocationpatch) | **PATCH** /bw_allocations/{allocationId} | Modify the information about a specific existing bandwidthAllocation by sending updates on the data structure
*BwmApi* | [**bandwidthAllocationPOST**](Apis/BwmApi.md#bandwidthallocationpost) | **POST** /bw_allocations | Create a bandwidthAllocation resource
*BwmApi* | [**bandwidthAllocationPUT**](Apis/BwmApi.md#bandwidthallocationput) | **PUT** /bw_allocations/{allocationId} | Update the information about a specific bandwidthAllocation
*LocationApi* | [**mec011AppTerminationPOST**](Apis/LocationApi.md#mec011appterminationpost) | **POST** /notifications/mec011/appTermination | MEC011 Application Termination notification for self termination


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

 - [AppTerminationNotification](./Models/AppTerminationNotification.md)
 - [AppTerminationNotificationLinks](./Models/AppTerminationNotificationLinks.md)
 - [BwInfo](./Models/BwInfo.md)
 - [BwInfoDeltas](./Models/BwInfoDeltas.md)
 - [BwInfoDeltasSessionFilter](./Models/BwInfoDeltasSessionFilter.md)
 - [BwInfoSessionFilter](./Models/BwInfoSessionFilter.md)
 - [BwInfoTimeStamp](./Models/BwInfoTimeStamp.md)
 - [LinkType](./Models/LinkType.md)
 - [OperationActionType](./Models/OperationActionType.md)
 - [ProblemDetails](./Models/ProblemDetails.md)


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

All endpoints do not require authorization.