Skip to main content

AWS Cloud Connectivity - 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.
  • AWS API operations use JWT bearer authentication. Send the token as Authorization: Bearer <access-token>.
  • 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 AWS Cloud Connectivity API:

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

Credentials​

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

List operations support limit (default 10, range 0-100) and offset (default 0). Pagination may be reported in the X-Total-Count and X-Result-Count headers.

Private Self-Made Cloud Connector​

MethodRouteSuccessGuide
POST/projects/{projectId}/aws/cloudconnectors/privates201Create
GET/projects/{projectId}/aws/cloudconnectors/privates200List
GET/projects/{projectId}/aws/cloudconnectors/privates/{id}200Get
PUT/projects/{projectId}/aws/cloudconnectors/privates/{id}200Replace
PATCH/projects/{projectId}/aws/cloudconnectors/privates/{id}200Update
DELETE/projects/{projectId}/aws/cloudconnectors/privates/{id}204Delete
GET/projects/{projectId}/aws/cloudconnectors/privates/{id}/resources200Read resources
DELETE/projects/{projectId}/aws/cloudconnectors/privates/{id}/resources/network204Delete network resources
DELETE/projects/{projectId}/aws/cloudconnectors/privates/{id}/resources/cloud/{resourceId}204Delete a cloud resource

Public Self-Made Cloud Connector​

MethodRouteSuccessGuide
POST/projects/{projectId}/aws/cloudconnectors/publicselfmades201Create
GET/projects/{projectId}/aws/cloudconnectors/publicselfmades200List
GET/projects/{projectId}/aws/cloudconnectors/publicselfmades/{id}200Get
PUT/projects/{projectId}/aws/cloudconnectors/publicselfmades/{id}200Replace
PATCH/projects/{projectId}/aws/cloudconnectors/publicselfmades/{id}200Update
DELETE/projects/{projectId}/aws/cloudconnectors/publicselfmades/{id}204Delete
GET/projects/{projectId}/aws/cloudconnectors/publicselfmades/{id}/resources200Read resources

AWS lookup operations​

PurposeMethod and route
List Orange locationsGET /aws/orangelocations
List public AWS regionsGET /aws/projects/{projectId}/public/regions?awsCredentialsId={awsCredentialId}
List private/transit VIF regionsGET /aws/projects/{projectId}/vif/{vifType}/regions?awsCredentialsId={awsCredentialId}
List target gatewaysGET /projects/{projectId}/aws/public/targetgateways?awsCredentialsId={awsCredentialId}&regionName={region}
List customer gatewaysGET /projects/{projectId}/aws/vif/{vifValue}/customergateways?awsCredentialsId={awsCredentialId}&regionName={region}

The VPN used by a connector is retrieved from the VPNaaS API, not this AWS API:

GET https://ope-obs.apibackbone.orange.com/evolutionplatform/vpnaaservice/api/v2/tenant/{tenantId}/vpns?connectivity=Any2Any&limit=100&offset=0