Skip to main content

Azure Cloud Connectivity API - Endpoint reference

Before you start
  • Follow the Set up access guide to obtain an access token for API calls.
  • You need access to an Evolution Platform organization and project.
  • The examples use the host ope-obs.apibackbone.orange.com. Replace {projectId} with your project UUID.
  • Send the JWT as an Authorization header.
  • For JSON requests, send Content-Type: application/json; use Accept: application/json when requesting JSON.
  • Replace path placeholders such as {projectId} and {id} with values from your project and connector.

Base URL for the Azure Cloud Connectivity API:

https://ope-obs.apibackbone.orange.com/evolutionplatform/azure/api/v1

Credentials​

MethodRouteSuccessGuide
POST/projects/{projectId}/azure/credentials201Create
GET/projects/{projectId}/azure/credentials200List
GET/projects/{projectId}/azure/credentials/{id}200Get
PUT/projects/{projectId}/azure/credentials/{id}200Update
PATCH/projects/{projectId}/azure/credentials/{id}200Update
DELETE/projects/{projectId}/azure/credentials/{id}204Delete

Private Self-Made Cloud Connector​

MethodRouteSuccessGuide
POST/projects/{projectId}/azure/cloudconnectors/privateselfmades201Create
GET/projects/{projectId}/azure/cloudconnectors/privateselfmades200List
GET/projects/{projectId}/azure/cloudconnectors/privateselfmades/{id}200Get
PUT/projects/{projectId}/azure/cloudconnectors/privateselfmades/{id}200Replace
PATCH/projects/{projectId}/azure/cloudconnectors/privateselfmades/{id}200Update
DELETE/projects/{projectId}/azure/cloudconnectors/privateselfmades/{id}204Delete
GET/projects/{projectId}/azure/cloudconnectors/privateselfmades/{id}/resources200Read resources
DELETE/projects/{projectId}/azure/cloudconnectors/privateselfmades/{id}/cloudresources/{rssId}204Delete a cloud resource
POST/projects/{projectId}/azure/cloudconnectors/privateselfmades/{id}/updatereservedbandwidth200Update reserved bandwidth
GET/projects/{projectId}/azure/cloudconnectors/privateselfmades/{id}/usage200Read usage

Public Standard Cloud Connector​

MethodRouteSuccessGuide
POST/projects/{projectId}/azure/cloudconnectors/publicstandarddynamics201Create
GET/projects/{projectId}/azure/cloudconnectors/publicstandarddynamics200List
GET/projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id}200Get
PUT/projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id}200Update
PATCH/projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id}200Update
DELETE/projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id}204Delete
GET/projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id}/resources200—
DELETE/projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id}/cloudresources/{rssId}204—
GET/projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id}/usage200—

Public High Availability Cloud Connector​

MethodRouteSuccessGuide
POST/projects/{projectId}/azure/cloudconnectors/publichadynamics201Create
GET/projects/{projectId}/azure/cloudconnectors/publichadynamics200List
GET/projects/{projectId}/azure/cloudconnectors/publichadynamics/{id}200Get
PUT/projects/{projectId}/azure/cloudconnectors/publichadynamics/{id}200Update
PATCH/projects/{projectId}/azure/cloudconnectors/publichadynamics/{id}200Update
DELETE/projects/{projectId}/azure/cloudconnectors/publichadynamics/{id}204Delete
GET/projects/{projectId}/azure/cloudconnectors/publichadynamics/{id}/resources200—
DELETE/projects/{projectId}/azure/cloudconnectors/publichadynamics/{id}/cloudresources/{rssId}204—
GET/projects/{projectId}/azure/cloudconnectors/publichadynamics/{id}/usage200—

Private Cloud Connector​

MethodRouteSuccessGuide
GET/projects/{projectId}/azure/cloudconnectors/privates?limit=10&offset=0200—
GET/projects/{projectId}/azure/cloudconnectors/privates/{id}200—
GET/projects/{projectId}/azure/cloudconnectors/privates/{id}/usage?startDate={startDate}&endDate={endDate}&unitFactor=mega&usageType=bandwidth200—

Azure lookup operations​

PurposeMethod and route
List Azure regionsGET /projects/{projectId}/azure/regions?azureCspCredentialId={azureCspCredentialId}
List resource groupsGET /projects/{projectId}/azure/resourcegroups?azureCspCredentialId={azureCspCredentialId}&azureRegion={azureRegion}
List virtual networksGET /projects/{projectId}/azure/vnets?azureCspCredentialId={azureCspCredentialId}&azureResourceGroup={azureResourceGroup}
List Azure locationsGET /projects/{projectId}/azure/locations?azureCspCredentialId={azureCspCredentialId}
List ExpressRoute gatewaysGET /projects/{projectId}/azure/expressroutegateways?azureCspCredentialId={azureCspCredentialId}&azureResourceGroup={azureResourceGroup}
Retrieve service-key dataGET /projects/{projectId}/azure/skey/{skey}/data
Estimate Public Standard connector costGET /azurecosting/publicstandarddynamics?azureRegion={azureRegion}&bandwidth={bandwidth}&currency={currency}
List bandwidths by locationGET /bandwidths?connectivityType={connectivityType}&displayLocation={displayLocation}&location={location}&limit=10&offset=0
List bandwidths by connectivity typeGET /connectivity/{connectivityType}/bandwidths?limit=10&offset=0