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; useAccept: application/jsonwhen 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
| Method | Route | Success | Guide |
|---|---|---|---|
POST | /projects/{projectId}/aws/credentials | 201 | Create |
GET | /projects/{projectId}/aws/credentials | 200 | List |
GET | /projects/{projectId}/aws/credentials/{id} | 200 | Get |
PUT | /projects/{projectId}/aws/credentials/{id} | 200 | Replace |
PATCH | /projects/{projectId}/aws/credentials/{id} | 200 | Update |
DELETE | /projects/{projectId}/aws/credentials/{id} | 204 | Delete |
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
| Method | Route | Success | Guide |
|---|---|---|---|
POST | /projects/{projectId}/aws/cloudconnectors/privates | 201 | Create |
GET | /projects/{projectId}/aws/cloudconnectors/privates | 200 | List |
GET | /projects/{projectId}/aws/cloudconnectors/privates/{id} | 200 | Get |
PUT | /projects/{projectId}/aws/cloudconnectors/privates/{id} | 200 | Replace |
PATCH | /projects/{projectId}/aws/cloudconnectors/privates/{id} | 200 | Update |
DELETE | /projects/{projectId}/aws/cloudconnectors/privates/{id} | 204 | Delete |
GET | /projects/{projectId}/aws/cloudconnectors/privates/{id}/resources | 200 | Read resources |
DELETE | /projects/{projectId}/aws/cloudconnectors/privates/{id}/resources/network | 204 | Delete network resources |
DELETE | /projects/{projectId}/aws/cloudconnectors/privates/{id}/resources/cloud/{resourceId} | 204 | Delete a cloud resource |
Public Self-Made Cloud Connector
| Method | Route | Success | Guide |
|---|---|---|---|
POST | /projects/{projectId}/aws/cloudconnectors/publicselfmades | 201 | Create |
GET | /projects/{projectId}/aws/cloudconnectors/publicselfmades | 200 | List |
GET | /projects/{projectId}/aws/cloudconnectors/publicselfmades/{id} | 200 | Get |
PUT | /projects/{projectId}/aws/cloudconnectors/publicselfmades/{id} | 200 | Replace |
PATCH | /projects/{projectId}/aws/cloudconnectors/publicselfmades/{id} | 200 | Update |
DELETE | /projects/{projectId}/aws/cloudconnectors/publicselfmades/{id} | 204 | Delete |
GET | /projects/{projectId}/aws/cloudconnectors/publicselfmades/{id}/resources | 200 | Read resources |
AWS lookup operations
| Purpose | Method and route |
|---|---|
| List Orange locations | GET /aws/orangelocations |
| List public AWS regions | GET /aws/projects/{projectId}/public/regions?awsCredentialsId={awsCredentialId} |
| List private/transit VIF regions | GET /aws/projects/{projectId}/vif/{vifType}/regions?awsCredentialsId={awsCredentialId} |
| List target gateways | GET /projects/{projectId}/aws/public/targetgateways?awsCredentialsId={awsCredentialId}®ionName={region} |
| List customer gateways | GET /projects/{projectId}/aws/vif/{vifValue}/customergateways?awsCredentialsId={awsCredentialId}®ionName={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